软件文档的编写要求

时间:2024-10-12 01:06:24

1、文档编写要有具体的目标 文档编制的时候应该分清楚读者是哪些人。然后按照不同的对象、不同类型的读者,去决定怎样适合他们的需求。

软件文档的编写要求

2、文档的编写要准确 文档的内容应该十分的确切,不能出现多义性的描述。同一个项目几个文档的内容应该是协调一致的,且之间是没有矛盾的。

软件文档的编写要求

3、文档的内容应该完整不漏 任何一个文档都应该是完整的、独立的、且自成体系。 为便于使用,文档间需要一些必要的重复,应该尽量避免读一种文档时又不得不去参考另一种文档。

软件文档的编写要求

4、文档编写的内容要清晰 文档的编写应该简单明了,如果有可能的话,还应该配上适当的图形和表格,从而来增强文档的清晰性。

软件文档的编写要求

5、文档应该是可追溯的 由于各开发阶段编制的文档与各阶段完成的工作是有着紧密关系的,前后两个阶段生成的文档,随着开发工作的逐步扩展,是会具有一定的继承关系。 在一个项目的每个开发阶段之间提惚改刮擗供的文档一定是存在着可追溯的关系,必要时应该能做到跟踪追查。

软件文档的编写要求
© 手抄报圈