软件文档写作学习总结——绪论

最近开始软件文档写作了。在从事嵌入式设计方面，软件的成本越来越高了。而众多嵌入式设计者的软件工程能力，文档写作能力成为一个瓶颈。

本文参考书籍是——软件文档写作教程 马平 电子工业出版社

• 软件文档是描述系统功能，刻画子系统间相互关系，提供给开发者的精确、完整的指导资料。
• 软件文档的最主要的目的是传达一个系统的技术要素和使用方法，第二是提供软件开发过程中的需求、决策、行为、角色和责任的书面记录。
• 软件文档的分类——可行性研究报告：实现技术，经济和社会条件，可能选择的方案，投资和效益分析，社会因素方面的可行性和结论        ——项目实施方案：具体计划，市场分析，项目概要，盈利模式，整体框架，负责人员，开发进度，开发经费，所需硬件和软件。 ——招投标文件：项目招标简介、企业信息化项目要求、咨询与实施需求，售后服务要求和信息系统要求 ——需求分析书：将客户的需求尽可能的深化，转化成文字记录。包括产品概述、主要概念、操作流程、功能列表和解说、注意事项和系统环境等。 ——概要设计书：功能实现、模块组成、功能流程图、函数接口、数据字典、考虑的问题。 ——详细设计书：对子系统和功能模块逐个分析 ——项目验收报告：系统的测试、验收和总结。维护工作。
• 软件文档的条件——完整性、准确性、易用性、及时性。
• 开发文档：描述开发过程本身      管理文档：记录项目管理信息 用户文档：记录用户所需的信息
• zbb521zbb@126.com