技术文档分类总结
参考:技术文档种类详解 | Technical Writer 可提供的交付物有哪些?
第一类文档,向导实例型(江湖杂谈)
“闭上眼睛就是天黑”--人的思维都是以某种定势封闭运转的,对于新场景、新知识、新问题,本能都会抵触。
向导实例好比是一扇窗,可以消除陌生和距离感,也可能起到激发兴趣的作用,但需要注意其中隐藏的细节需要在进一步的学习中仔细掌握。
第二类文档,参考手册型(修行功法)
内容连贯、全面、详细的,比如XX基础学习/入门/指南/解析,还有各类技术官方文档和接口文档都属于此类。
要求精读精练,坚持下去必有所成。
第三类文档,技术提高型(经验之书)
各类Howto(辅导书)、FAQ(错题集)、Troubleshooting(疑难杂症),还有诸如xx的艺术/技术内幕/深度剖析等等。
第四类文档,辅助决策型(对战宝典)
产品白皮书、项目案例、版本发布说明等等。

浙公网安备 33010602011771号