最近在写文档,包含概要设计、详细设计、数据库设计和接口设计,下面是写文档过程中出现的一些问题,这里跟大家分享一下。
封面统一
添加变更记录
添加/更新目录
页眉
页脚
表格
- 根据窗口自动调整表格
- 首行居中对齐
- 序号一列水平居中
- 首行首列加底色(灰色)
段落
- 首行缩进两字符(注意左侧不要有缩进)
- 行间距统一单倍行距
图片
具体内容
- 标点符号:中文中不要使用英文的标点符号
- 语句通顺(互相检查)
定义
其他
- 功能结构图等图片使用黑白两色,字体、字号统一(宋体,10pt)
- 概要设计中功能需求与程序,表格头上加个斜线文字
- 概要设计中接口设计可以使用表格,表达更加清晰
- 参见附表附件可以放在文档最后,如果不想写附表的话可以参见《xxxx》
- 概要设计中运行控制可以写利用鼠标和键盘的控制方式(需扩展)
- 文字描述可参考初步建设方案、采购合同、需求规格说明等