育才学习网1. 怎么写项目开发的文档
软件开发中文档的编写是一个不可缺少的环节，常见的如《需求分析》、《概要分析》、《数据库设计》等。在“软件人”的阵营里向来存在两种观点，注重文档还是关心代码。
我这里写一个《用户信息模块的概要设计文档》，只列举主要内容了
1.功能描述：用于完成系统用户信息的新增、删除、修改、查询；
2.功能用例：一个主用例用户信息，附加新增、删除、修改、查询4个子用例，操作人员为管理员，图形就不画了，很简单的；
3.业务流程：查询有效范围用户信息——》新增用户信息——》判断当前帐号是否存在——》存在给出提示，反之保存成功提示。
4.约束限制：超级管理员可操作所有（包含删除，我这里考虑仅是逻辑删除、非物理删除）的用户信息；系统管理员可操作除系统管理员、超级管理员外的全部用户信息；单位管理员可操作本单位用户信息；用户帐号信息系统内全局唯一；
5.系统性能：要求同时支持500个并发操作；页面操作响应时间小于1s；页面大小小于1kb;
当前用户所属员工信息不存在时，可直接进行员工信息的添加，并完成用户信息的同步保存，确保事务的完整性；
6.运行环境：依赖系统整体运行环境为准（存在特殊需要注明）；
7.操作实体：用户信息、员工信息、系统日志等。
8.异常处理：如果系统框架中已经提供相关说明，这里仅需要注明符合系统架构异常处理方式即可。
9.外部接口：输入—用户ID，输出—用户信息；
10.其他说明：用户帐号必须定义为字母开头，数字与字母组合，并保证全局唯一；用户密码采用md5算法加密，系统架构已提供相关接口。
11.注意事项：用户帐号不能为空，不能存在空格，不能超过6位；超级用户信息仅在系统初始化中完成其信息写入操作，其他用户无权对其进行修改。
项目组中也不是所有人都必须参与文档的编写，通常业务需求人员、设计人员、架构师、项目经理、小组长占大多数，而且这些人中很多也不是专注于写代码的角色。
2. 软件开发文档应该如何写
模块开发卷宗（GB8567——88）
1标题
软件系统名称和标识符
模块名称和标识符（如果本卷宗包含多于一个的模块，则用这组模块的功能标识代替模块名）
程序编制员签名
卷宗的修改文本序号
修改完成日期
卷宗序号（说明本卷宗在整个卷宗中的序号）
编排日期（说明整个卷宗最近的一次编排日期）
2模块开发情况表
3功能说明
扼要说明本模块（或本组模块）的功能，主要是输入、要求的处理、输出。可以从系统设计说明书中摘录。同时列出在软件需求说明书中对这些功能的说明的章、条、款。
4设计说明
说明本模块（或本组模块）的设计考虑，包括：
a. 在系统设计说明书中有关对本模块（或本组模块）设计考虑的叙述，包括本模块在软件系统中所处的层次，它同其他模块的接口；
b. 在程序设计说明书中有关对本模块（或本组模块）的设计考虑，包括本模块的算法、处理流程、牵涉到的数据文卷设计限制、驱动方式和出错信息等；
c. 在编制目前已通过全部测试的源代码时实际使用的设计考虑。
5原代码清单
要给出所产生的本模块（或本组模块）的第一份无语法错的源代码清单以及已通过全部测试的当前有效的源代码清单。
6测试说明
说明直接要经过本模块（或本组模块）的每一项测试，包括这些测试各自的标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的输出。
7复审的结论
把实际测试的结果，同软件需求说明书、系统设计说明书、程序设计说明书中规定的要求进行比较和给出结论。
3. 软件开发中详细设计文档怎么写
原发布者：阳阳1A
QR-RD-022(Ver1.2)XXX系统详细设计说明书（内部资料请勿外传）XX公司版权所有不得复制文档变更记录1.引言1.1编写目的和范围说明写这份详细设计说明书的目的。本详细设计说明书编写的目的是说明程序模块的设计考虑，包括程序描述、输入/输出、算法和流程逻辑等，为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。1.2术语表定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息。1.3参考资料列出有关资料的名称、作者、文件编号或版本等。参考资料包括：a.需求说明书、架构设计说明书等；b.本项目的其他已发表的文件；c.引用文件、资料、软件开发标准等。1.4使用的文字处理和绘图工具文字处理软件：wordoffice绘图工具：Visio2.全局数据结构说明本章说明本程序系统中使用的全局数据常量、变量和数据结构。2.1常量staticStringSERVER_ADDRESS服务器地址booleanloginFlag登录状态2.2变量BlueUserInfo 用户账户结构体2.3数据结构包括数据结构名称，功能说明，具体数据结构说明（定义、注释、取值）等。3.模块设计3.1用例图3.2功能设计说明3.2.1登录模块模块1主要分为以下几个子模块：子模块1、子模块2和子模块N。3.2.1.1设计图
4. 软件开发可不可以先写程序再写文档
那要看是什么文档了， 1） 一般来说分析、设计文档应该是要先有的，特别是开发比较复杂的系统，如果没有很好的规划设计，程序结构可能会比较混乱。
所以应该先有文档，当然这个文档可以不是十分的全面，可以在开发过程中逐步补充完善，但至少是要有框架式的文档。 2） 对于小型程序开发，一个人就搞定了；你可以先写好程序，然后再把关键功能、算法、流程什么的整理成文档，以免自己以后忘掉了难以维护。
3） 用户帮助文档之类的肯定是要等程序完成、测试OK再写了。 文档最主要的作用，我认为一是帮助你理顺设计、开发思路，有句话Once a problem is described in sufficient detail,its solution is obvious；二是方便后续维护。