编程让世界更便捷
你会写软件开发文档吗？
如今，软件开发越来越复杂，软件的功能也越来越丰富。而几乎所有成熟的商业软件，都是一个开发团队齐心协力的血汗结晶。“罗马不是一天建成的。”，当我们震撼于Microsoft Windows的惊世巨著的同时，也道听途说了一些微软公司软件工程是如何的完善和规范。软件项目管理的成败是控制开发成本的关键环节。这里面，少不了贯穿其中的重要步骤——软件文档。
软件文档可以分为开发文档和产品文档两大类：开发文档包括：《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。产品文档包括：《产品简介》、《产品技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、 《用户报告》、《销售培训》等。
一、开发文档
1. 《功能要求》——来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，又或者是参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。
2. 《投标方案》——根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写《投标方案》，方案书一般包括前言、需求分析、技术方案、项目管理、技术支持、系统报价、项目进度等。
3. 《需求分析》——包括产品概述、主要概念、操作流程、功能列表、注意事项、系统环境等。以《功能要求》为基础，进行详细的功能分析，列出本产品是什么，有什么特殊的概念，包括那些功能分类，需要具备什么功能，该功能的操作如何，实现的时候该注意什么细 节，客户有什么要求，系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。
4. 《技术分析》——包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以《需求分析》为基础，进行详细的技术分析（产品的性能和实现方法），列出本项目需要使用什么技术方案，为什么，有哪些技术问题要解决 ，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。
5. 《系统分析》——包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以《需求分析》为基础，进行详细的系统分析（产品的开发和实现方法），程序员根据《系统分析》，开始在项目主管的带领下进行编码工作。
6. 《数据库文档》——包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以《系统分析》为基础，进行详细的数据库设计，必要时可以用图表解说，特别是关系数据库。
7. 《功能函数文档》——包括变量名、变量初植、功能、函数名、参数、如何调用、备注、注意事项等。以《系统分析》为基础，进行详细的说明，列出哪个功能涉及多少个函数，以便以后程序员修改、接手和扩展。
8. 《界面文档》——包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求，这里与软件完成后的运行界面是一致的。
9. 《编译手册》——包括服务器编译环境、操作系统、编译工具、编译器版本信息、目录说明、程序生成、源程序文件列表、Makefile配置及其相关程序的对应关系列表。客户端的编译过程、编译结果、编译示例、编译环境、操作系统、编译工具、源文件列表和制作安装程序的过程。
10. 《QA文档》——包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要求等，提供给软件测试人员使用。
11. 《项目总结》——包括项目简介、项目参与人员和开发时间、项目风险、管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员工作情况等。
二、产品文档
1. 《产品简介》——包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公司联系地址等。
2. 《产品演示》——包括公司简介、产品背景、产品描述、产品特点、产品作用、适用范围、使用分析、功能模块、解决问题、合作伙伴、成功案例等。一般用Powerpoint或者视频录制软件实现。
3. 《疑问解答》——列出用户关心的问题和处理方法，用于解答软件的操作功能和解决用户的疑难问题。
4. 《功能介绍》——以《需求分析》为书写基础，包括软件介绍、软件结构、功能列表、功能描述等。
5. 《技术白皮书》——以《技术分析》为书写基础，包括功能实现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向等。
6. 《评测报告》——第三方的权威评测报告。包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。
7. 《安装手册》——包括系统环境、运行平台、产品安装过程、初始环境设置、安装记录等。
8. 《使用手册》——包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等。
9. 《维护手册》——包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份、技术问题解答和联系方式等。
10. 《用户报告》——包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等。
11.《销售培训》——包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、目标客户等。
没有更多推荐了，豆丁微信公众号
君，已阅读到文档的结尾了呢~~
计算机软件开发文档编写指南
扫扫二维码，随身浏览文档
手机或平板扫扫即可继续访问
计算机软件开发文档编写指南
举报该文档为侵权文档。
举报该文档含有违规或不良信息。
反馈该文档无法正常浏览。
举报该文档为重复文档。
推荐理由：
将文档分享至：
分享完整地址
文档地址：
粘贴到BBS或博客
flash地址：
支持嵌入FLASH地址的网站使用
html代码：
&embed src='http://www.docin.com/DocinViewer--144.swf' width='100%' height='600' type=application/x-shockwave-flash ALLOWFULLSCREEN='true' ALLOWSCRIPTACCESS='always'&&/embed&
450px*300px480px*400px650px*490px
支持嵌入HTML代码的网站使用
您的内容已经提交成功
您所提交的内容需要审核后才能发布，请您等待！
3秒自动关闭窗口软件公司规范性软件开发文档够用就好，切莫追求完美主义
相信所有的都有各种类型的开发要求和编码规范性，
这些软件开发文档主要针对开发过程中的各种工作行为做一个规约性的要求，其作用也就不言而喻。对于软件开发过程中几乎所有的团队都在使用这些规范，有编码
规范，开发环境设定软件开发文档，还有各种工作约定的规范软件开发文档，但是其效果可能有天壤之别。作为软件开发项目经理，那么在软件开发项目启动之前，
这些规范软件开发文档的选取和制定也需要一定的技巧。
当我们在制定这些开发规约的时候，首先注意需要注意的是这些开发规范的尺度，也就
是说所要制定的的开发规范需要详细到哪种程度，是否是面面俱到，和法律文书一样周全严禁；还是说蜻蜓点水，点到而止。甚至有不少公司从网络直接下载下别人
现成的开发规范，拿来己用，那么我们在制定这种软件开发文档的时候需要注意的问题有那些呢？
公司已经确认软件开发项目可以进行，从现在
到软件开发项目的实际开始还有一段时间，人员的招聘目前HR还在想方设法去完成，但是对于软件开发项目组内部来说，这段时间需要我们做的事情也是非常繁琐
和重要，首先需要考虑到人员进来之后的再次培训工作，虽然公司已经对进来的人员有一个针对公司制度和文化的培训，但是还缺乏一些工作性质的培训，特别是这
个软件开发项目的人员既有新人、外软件开发项目组的、外驻人员，如此的团队有必要在软件开发项目开始前进行一些列的培训，所以培训材料的准备也是计划中的
一部分，还有开发中的开发规范和工作准则等等，这些都是前期软件开发文档性的东西，一起虽然都由，但是还是需要安排人员整理。
一直在考虑这个问题，如果说我们的开发人员有良好的开发习惯的话，那么这些规范对于他们来说作用不太大，因为他们的做事方法已经达到我们的开发要求。开发
规范的主要作用就是说统一整个团队的风格，尽量保证开发出来代码的质量。理想情况下，整个团队所有人写出来的代码就像出自一人之手，但是可能性很小，在整
个团队中，如果希望做到所有的风格一致，那么我们可能做出来的开发规范可能就需要做到想法律文书一样，厚厚一本。&
对于软件开发项目
开发过程中选择开发规范的时候，其可选择性和考虑的问题也比较多，那么当我们在尝试指定这些规约性的时候，其内容的覆盖程度不能作为主要的考虑点，我们更
多需要考虑这些软件开发文档的学习成本和实用性。如果说所有的问题都考虑到了，细节性问题，突发性问题等等，那么规范内的条款也就会对应增加，那么对于团
队的成员在学习这些规范的时候，其学习的周期就会比较长，而且由于其中规定的内容比较多，学习之后的遗忘量也就比较大，很难让他们做到完全记住，并且能够
贯彻使用。由于学习周期比较长，那么学习成本也就非常高，之后的遗忘，那么规范的实用性也就较差。
有时候我们在做事情的时候，往往容易
为了百分之五的问题，而投入了百分之九十的精力，而且当这百分之五是属于偶然性的问题的时候，那么这种投入就更没有价值。如果我们希望追求完美，那么在这
种软件开发项目开发过程中并不适用，所以不论指定开发规范也好，还是制定工作要求也好，只要能够被彻底、坚持执行的规范才算是有意义，否则都是一纸空文，
其作用也不过是为了事后应付差事罢了。
软件开发项目经理在指定这些规范，实用性、学习周期、可执行度都需要考虑一番，所以不论是从网上下载的也好，还是自己从头制定也好，能把这些问题都考虑到了，做出一个权衡之后选择适合自己团队的规范性软件开发文档，一切一切只要够用就好，切莫追求完美主义。
已投稿到：
以上网友发言只代表其个人观点，不代表新浪网的观点或立场。已解决问题
FAQ-为什么许多软件开发团队与个人都不（爱）写开发文档？
提问时间： 06:11:09
浏览次数：6448
该答案已经被保护
整个行业现在流动性都比较大，如果觉得自己做的事情是在机械重复可以考虑转岗，内部转岗不成就跳一下，离开自己的舒适区虽然痛苦，不管是薪资还是发展都会好一点。&br/&&br/& 感觉自己技术水平到了上限的时候，建议找一个靠谱的项目稳定下来，说不定以后做成了就是一辈子的事业了。&br/&&br/& 微博@huntcoder@_@我跟你一样啊,我大学学校里学习的是java,主要都是ssh和spring mvc后来在大学里面还自学了android为以后工作做准备,但是实习无奈学校所在的是三线城市绍兴,那边只有几家做php的,实习嘛,就是为了学习,不是为了正式要闹腾成怎样,安逸就好,而且住在学校,离上班地点也近,就没去杭州做android,于是乎一礼拜学会了php,掌握了ci和tp两个框架,然后就去上班了,上班了一个月,觉得这个公司的业务实在无感,没什么技术提升的空间,然后加上自己本来就喜欢做app,但是android基本都会了,想深入学习 这个时候,由于自己有台macbook,没有深入android,而是学了ios...........，也挺搞笑的,学会了ios,开了个人开发者账号,自己用php做了几个webservice,然后拿几个app就审核store,但是做的难一点的就是pjsip＋xmpp的,然后我还给做了android的app(但是就是用了asmack的jar,其他功能没像ios这么丰富),基本web(php)+android+ios 然后我就去了杭州,辞职了绍兴的公司,在杭州的公司呆了半年多也接近一年了,打出了两套app的主程序,一直在为这两套app迭代,由于后台也是用php写的,开发效率很高,每天闲着........ 我觉得自己是闲不住的人,在公司闲着的时候,看了很多java的东西,重温了ssh和spring mvc等等,然后还看了jndi/jms/ejb/面向服务架构/之类的东西,业余双休基本都在做东西,做了很多自己的产品,架设在自己的web上,后来真的感觉没什么长进了............就想着去上海 于是乎去了上海,以ios的面试者身份进了一家公司,做了一个什么都做的开发（公司是来不及招人了,也为了节约资本...........上司是个10多年的编程经验的人物..........还叫我学了python的django,公司后台api基本都是django.......我学了django之后顺带看了一些nodejs的express感觉angularjs真的挺好的,然后打了半天的express代码写了一个cms的API挺小的web应用,前端用bootstrap+angularjs,觉得这类轻量级的express和django基本不适用大型的系统设计,就不想学下去了,还是继续研究java的分布式架构和中间件 最近买了很多的书,现在呆在公司又研究起来了一些java上的分布式架构。【工作职责】 　　企业的IT架构师首先不仅是一个技术专家,同时也是一个业务专家.有比较丰富的项目实施经验,能够结合企业的实际情况指导软件工程师进行开发工作，发现并指出编码存在的问题并提出解决方法，评审他们的工作；及时有效地解决设计、开发人员所提出的问题，解决技术上的难题；制订并规范系统设计和开发文档、工具、模型；能否让其他人员容易理解;经常组织并带领IT人员或项目组分享、研究、学习与项目相关的新技术；在碰到技术难点上,IT架构师应该起带头作用重点攻关,评估并确认最终方案,确保IT项目的实施不受技术约束。&br/&&br/& IT系统架构师，一定要有自信，既不要保守，也不要人云亦云，不会迷信于厂商吹得天花乱坠的方案介绍和销售顾问的不考虑后果的胡乱承诺,对相应的IT解决方案都可以比较有把握地提出自己鲜明的观点和方案.大多数IT架构师的个性比较突出和鲜明,会根据自己所掌握的技术或业务能力,旗帜鲜明地阐述自己的观点,有时甚至不会太顾忌上下领导关系,厂商面子,比较客观地把方案的问题或风险暴露无遗.这是架构师的优点,也可以说是架构师的缺点,处理不好的话会让自己陷入困境之中,甚至丢掉饭碗.同时,大部分IT架构师在做决策或方案时,不太喜欢别人指手划脚,这也或多或少跟其高度自信的特征有关.同样,好的IT架构师对自己的错误敢于承认,不会找太多的借口为自己辩护,这点也是IT架构师比较受认可且必须的一项职业素养指标. 【角色&地位】 　　&冰冻三尺，非一日之寒&，优秀的IT架构师除了要有很深的专业技能外，还需技术全面、成熟练达、洞察力强、经验丰富，具备战略性和前瞻性思维能力，善于把握全局，能够在更高抽象级别上进行思考。
答案创立者
以企业身份回答&
快速解决你的电商难题
店铺优化排查提升2倍流量
擅长&nbsp 店铺优化
您可能有同感的问题Copyright (C)
www.epwk.com 厦门一品威客网络科技股份有限公司版权所有 备案：闽ICP备号