产品文档的几点注意

产品文档由产品部门编写,有点类似于需求文档。在看过产品部门的文档,再加自己的几点体会,觉得文档主要要注意以下几点。
1)文档一般由word工具编写。
2)文档的声明。包括文档的标题,一级标题,文档简介,文档出处,文档时间,文档版本等。排版合理即可,没有字体大小的硬性规定。应该位于文档的最前面,占一页。<!--more-->
3)文档的目录。不论文档长短与否,必须要有目录。
4)在文档中必须要有清晰的章节安排。多使用一级标题,二级标题等。
5)页码必须要有
6)关键字可以使用不同颜色标出。但颜色不可使用过多,推荐正文黑色,关键字使用红色。醒目标注也不可过多,容易让人眼花。
7)要有批注。
8)需要效果实现的地方一定要配图。
9)一定多使用表格。
10)比较大的图和一些资源不要直接引入文档,应作为附件。
11)附件在最后注明。并且需附上联系人。
12)如有补充说明,应在页尾申明。
12)应将所有文档文件打包压缩。

发表评论

电子邮件地址不会被公开。 必填项已用*标注