写技术文档,要不要用文档模板?
来源:互联网 发布:淘宝代金券怎么领取 编辑:程序博客网 时间:2024/05/14 17:20
摘要: 文档模板的存在究竟是好是坏,因人因事而异。此外我们也应该分清楚:何时应该使用文档模板,何时不要使用文档模板?怎么去分清楚呢?这里列出了使用模板的好处和缺点,为大家提供一个参考。 使用模板的缺点 使用模板同样也存在缺点: 1、你会觉得有义务将模
文档模板的存在究竟是好是坏,因人因事而异。此外我们也应该分清楚:何时应该使用文档模板,何时不要使用文档模板?怎么去分清楚呢?这里列出了使用模板的好处和缺点,为大家提供一个参考。
使用模板的缺点
使用模板同样也存在缺点:
1、你会觉得有义务将模板内的每个章节都填上文字,你认为这样才是一个完备的文档,这导致许多节的内容被填入一些没有太大意义的陈词滥调。
2、这些“杂讯”会造成文档阅读者的困扰。我看到一些PRD(Product Requirement Document,产品需求文档)的内容有数十页,但真正有价值的却只有几页。
3、你觉得只能依照文档模板的规范写,这会造成视野变窄,因为模板钳制了你的思想,让你无法对当前所写的主题进行创新地思考。
4、如果你认为必须根据模板的前后次序填入内容,可能会造成写作的停滞,因为有些小节的内容你无法理解。
使用模板的好处
主要有这样几点:
1、在你毫无头绪时,文档模板具有引导写作的功效。
2、文档模板可以帮助你不会遗漏一些该写的重点(假设该模板已经很完备)。
3、你可以专注写内容,不用分心去管板型(因为模板都已经将这些设置好了)。板型很重要,好的板型有助于阅读。
- 写技术文档,要不要用文档模板?
- 项目管理---敏捷开发---到底要不要写文档?
- 学习写技术文档
- 开始写技术文档
- 开始写技术文档
- 如何写技术文档
- 敏捷开发实践(2)-要不要文档?
- 敏捷开发实践(2)-要不要文档? .
- 用markdown编辑器写技术接口文档
- 技术领导要不要写代码?
- 技术领导要不要写代码
- [转]技术领导要不要写代码?
- 技术领导要不要写代码
- 技术文档怎么写呢?
- 怎样写好技术文档
- 如何写好技术文档
- 写技术文档的体会
- 怎样写好技术文档
- 大一的一年总结
- csdn上转了一圈
- [转]暗时间
- android的控件美化
- 程序员的档次论——来自于变成之美(老赵)
- 写技术文档,要不要用文档模板?
- 用选择法对十个整数排序
- JavaScript非常实用的七大技巧
- 用JBuilder9制作EXE文件不公开秘笈
- 隋记
- 2010-10-05
- yyyy
- 国庆假期
- java安装的环境变量配置