2020-07-21 09:09:58 版本 : 写概要设计、详细设计、数据库设计、接口设计文档注意事项
作者: 陈婉 于 2020年07月21日 发布在分类 / 人防组 / 人防其他 下,并于 2020年07月21日 编辑
 历史版本

修改日期 修改人 备注
2020-07-21 09:12:24[当前版本] 陈婉 格式调整
2020-07-21 09:11:40 陈婉 格式调整
2020-07-21 09:09:58 陈婉 创建版本

最近在写文档,包含概要设计、详细设计、数据库设计和接口设计,下面是写文档过程中出现的一些问题,这里跟大家分享一下。

封面统一

添加变更记录

添加/更新目录

页眉

l  封面没有,其他页面都有,文字居中且保持一致

页脚

l  页码,居中例如 1/30

表格

l  根据窗口自动调整表格

l  首行居中对齐

l  序号一列水平居中

l  首行首列加底色(灰色)

段落

l  首行缩进两字符(注意左侧不要有缩进)

l  行间距统一单倍行距

图片

l  文字要清楚

l  要有图号和图名

l  要居中

具体内容

l  标点符号:中文中不要使用英文的标点符号

l  语句通顺(互相检查)

定义

l  系统名称缩写,需求规格说明书、接口文档等缩写

其他

l  功能结构图等图片使用黑白两色,字体、字号统一(宋体,10pt

l  概要设计中功能需求与程序,表格头上加个斜线文字

l  概要设计中接口设计可以使用表格,表达更加清晰

l  参见附表附件可以放在文档最后,如果不想写附表的话可以参见《xxxx

l  概要设计中运行控制可以写利用鼠标和键盘的控制方式(需扩展)

l  文字描述可参考初步建设方案、采购合同、需求规格说明等


历史版本-目录  [回到顶端]
    知识分享平台 -V 4.8.7 -wcp