软件文档伴随软件生命周期各阶段逐步编写,部分文档仅反映单一阶段成果,另一些则需跨越多个阶段持续更新和完善。
1、 编写文档需明确具体目标。
2、 编写文档时需明确目标读者,针对不同对象和读者类型,调整内容与表达方式,以更好满足其实际需求。
3、 文档编写需准确无误
4、 文档内容需准确无误,避免歧义。同一项目的各文档应保持一致,相互之间不得存在矛盾或冲突。
5、 文档内容需完整无遗漏。
6、 每个文档应内容完整、独立存在,并形成自身逻辑体系。
7、 为方便使用,文档间可适当重复内容,尽量减少查阅不同文档的需要。
8、 文档内容需条理清晰、易于理解
9、 文档应简洁明了,尽量辅以合适的图表,以提升内容的清晰度和可读性。
10、 文档需具备可追溯性
11、 各开发阶段所编写的文档与该阶段的工作内容密切相关,且前后阶段的文档在开发逐步推进过程中,存在一定的延续性和继承性。
12、 各开发阶段的文档应保持可追溯性,确保在需要时能够有效追踪和核查相关信息。
