文档编写注意事项
Posted jiuyang
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了文档编写注意事项相关的知识，希望对你有一定的参考价值。
1、确立项目名称（响亮的英文名）
注重逻辑性
版本更新要与项目名称相同
术语与缩略语
2、目录及架构
简介
应用场景
标准的需求描述规范
3、关键概念（业务逻辑，描述核心思维）
4、功能框图（技术描述功能，按逻辑输出）
5、部署角色
6、功能约束（不能干的事，数据传入格式等）
3、系统用例
4、功能定义（用例的具体实现）
5、非功能性需求（质量控制）
性能：
可配置性：
可靠性：
以上是关于文档编写注意事项的主要内容，如果未能解决你的问题，请参考以下文章