软件开发的文档怎么写( 三 ) _文档

虽然这在理论上是说得过去的，但是不应该将开发人员看成文档作者。很简单，技术人员只被培训如何开发，而没有被培训如何写文档。为了解决这一问题，很多应用程序开发经理尝试通过聘请一些技术性写手或商业分析人员来提高他们的软件文档的质量。这就导致出现了一个相反的问题：技术写手和商业分析人员通常只有有限的技术技能。
解决方案依赖于文档，文档应该迎合其潜在读者的口味。这方面的通用规则是要求使用一个协同工作方法来编写文档，这种方法允许开发人员和写手发挥他们的长处。例如，如果潜在的读者是系统设计人员，那么开发人员应该提供详细的输入，但是允许技术写手去组织和编辑内容以使文档符合语法。
不管潜在的读者还是被选中的读者，软件文档的质量与其可使用性相关，以下六个属性可以用来测量软件文档的可使用性：
· 适用性：文档提供了相关的信息吗？
· 合时性：文档所提供的是当时的信息吗？
· 正确性：文档所提供的信息正确吗？
· 完整性：文档是不是足够详细？
· 可用性：文档随手可用吗？
· 可使用性：能够快速直观地找
5.软件文档怎么写下面的格式你可以参考一下，跟论文差不多的
主要还是要根据你实际编写的软件来写
*************************************
1.引言
1.1编写目的
1.2项目背景
1.3定义
1.4参考资料
2.2软件结构
3.程序描述
3.1功能
3.2性能
3.3输入项目
3.4输出项目
3.5算法
3.6程序逻辑
3.7接口
3.8存储分配
3.9限制条件
3.10测试要点
6. 软件开发需要编写哪些文档如，开发阶段、文档化要求程度等，若是通过CMM评估的，文档就较多一般的是按项目开发过程来分，基本的有可行性研究报告（若是一个新项目且未确定的或应客户要求时需要，实际上大部份公司很少有这文档）用户需求说明书（用户+开发人员共同确认）软件需求规格说明书设计说明书（体系结构、详细设计）测试用例用户手册实现代码这些文档中，包括一定的分析与设计图形，如用例图、数据库结构、ER图等当然项目计划、测试计划也应算在内其它的（如CMM要求的）风险、估算方面的，质量保证方面的、配置管理方面、定义的模板、度量数据库等具体需要多少文档就是要看项目实际这方面的东西，可参考一些软件工程类的书。

文章插图