软件文档编写规范（技术文件编写规范）

软件文档的质量甚至关乎项目的最终成败和可维护性。文档编写需要遵守以下规范：

1、针对性。文档编制前应分清读者对象。对不同的类型、不同层次的读者，决定如何满足适应他们的需要。
2、精确性。文档的行文应当十分确切，不能出现多义性的描述。
3、清晰性。文档编写应力求简明，如有可能，配以适当的图表，以增强其清晰性。
4、完整性。任何一个文档都应当是完整的、独立的，它应自成体系。例如，前言部分应做一般性介绍，正文给出中心内容，必要时还有附录，列出参考资料等。
5、灵活性。各个不同软件项目，其规模和复杂程度有着许多实际差别，不能相同看待。