程序说明怎么写 求大神

程序说明书包括如下七个内容：

1.程序名称；包括反映程序功能的文字名称和标识符。

2.程序所属的系统、子系统或模块的名称。

3.编写程序所需使用的语言。

4.输入的方式和格式：当程序有多种输入时，分别对每种输入方式与格式做出具体而细致

的说明。

5.输出的方式与格式：当程序有多种内容按不同方式输出时，分别说明不同内容按不同方

式输出时的格式。

6.程序处理过程说明：包括程序中使用的计算公式，数学模型和控制方法等。

7.程序运行环境说明：对程序运行所需要的输入输出设备的类型和数量，计算机的内存及

硬盘容量，支持程序运行的 *** 作系统等内容进行说明。

由于种种原因，在实际工作中不太重视程序说明书的编写工作。这既不利于程序的设计工作，更不利于对程序的修改和维护工作。因为系统投入运行后，需要经常根据情况的变化进行调整和修改，如果没有完善的文档资料，维护、修改就很难进行。

1 引言

1．1编写目的

说明编写这份详细设计说明书的目的，指出预期的读者。

1．2背景

说明：

a．待开发软件系统的名称；

b．本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。

1．3定义

列出本文件中用到专门术语的定义和外文首字母组词的原词组。

1．4参考资料

列出有关的参考资料，如：

a．本项目的经核准的计划任务书或合同、上级机关的批文；

b．属于本项目的其他已发表的文件；

c．本文件中各处引用到的文件资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。

2 程序系统的结构

用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间 的层次结构关系。

3 程序1（标识符）设计说明

从本章开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。 对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层 模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。

3．1程序描述

给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且，还要说明本程序的特点（如 是常驻内存还是非常驻？是否子程序？是可重人的还是不可重人的？有无覆盖要求？是顺序处理还是并发 处理卜…．．等）。

3．2功能

说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图）的形式。

3．3性能

说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。

3．4输人项

给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。 数量和频度、输入媒体、输入数据的来源和安全保密条件等等。

3． 5输出项

给出对每一个输出项的特性，包括名称、标识、数据的类型和格式，数据值的有效范围，输出的形式、 数量和频度，输出媒体、对输出图形及符号的说明、安全保密条件等等。

3．6算法

详细说明本程序所选用的算法，具体的计算公式和计算步骤。

3．7流程逻辑

用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。

3．8接口

用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷）。

3．9存储分配

根据需要，说明本程序的存储分配。

3．10注释设计

说明准备在本程序中安排的注释，如：

a． 加在模块首部的注释；

b．加在各分枝点处的注释； 对各变量的功能、范围、缺省条件等所加的注释；

d．对使用的逻辑所加的注释等等。

3．11限制条件

说明本程序运行中所受到的限制条件。

3．12测试计划

说明对本程序进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定。

3．13尚未解决的问题

说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。

4 程序2（标识符）设计说明

用类似3的方式，说明第2个程序乃至第N个程序的设计考虑。

程序员日常开发工作，基本是上离不开阅读文档，这也是很多程序员喜欢两个显示器的原因。

项目方面

技术方面

是不是很多人都认为，如果在开发过程中，还要不断地翻技术文档，说明他的开发能力不扎实。其实不是这样的。

首先IT行业技术升级换代的速度太快，当我们大多数公司还在用Java8的时候，Java11都已经出来了。如果非得要程序员熟知每一个类、每一个方法，是很不现实的。

很多时候我们只需要了解有这么一个东西，作用是干什么的，具体的细节可以在用的时候再去翻文档，比如方法名字是什么？参数有几个，都是什么类型的？

所以我们都习惯至少两个电脑屏幕，一个屏幕写代码，一个屏幕看文档；如果豪一些的话，再加一个屏幕展示日志信息。

看文档的屏幕要买竖屏！

我们团队

我这几年也带过几个团队，对于每个团队成员，我对他们的要求是：实现需求的前提下，最好能对所用的技术有一定的了解，千万不要从网上抄过来一段代码就用，这样是很危险的行为。所以鼓励大家多找一些资料，最好是阅读框架的官方文档。

现在的团队，我已经这样要求了：代码写累了，或者觉得自己没有状态写代码，可以找点儿自己有兴趣的技术文档学习学习，这个技术甚至是可以跟现在的项目没有关系的。

首先，我不是程序员，我是一个设计工作者，不过我来说一下我的观点：很多人以为程序员像电影里的一样，啪啪啪几下键盘，屏幕数据飕飕的变，其实真实情况是程序员写代码就像学生写作文，也会遇到不会的词语跟修辞手法，那这个时候就要停下来想一想，查一查，看看例子是怎样写的怎样用的，写错了还要划掉（删掉）再来，至于这个大量不大量看的情况，如果这个是个新手，那肯定是可以的，那如果是个老手，还需要大量时间查说明文档，那就说明这个项目肯定不会小，不是一两天能做完的，那一个用月做单位的项目，用一个天做单位的时间来查文档，不过分吧！程序员也是人，不是因为他的工作高端，就觉得这个人万能，他也会当机，要吃饭，要休息，也会忘记一些东西，所以请各位多多体谅，能一起工作实属不易，感恩2018，谢谢。

这个问题怎么说呢，开发过程中会遇到各种各样的问题，没有一个人是全能的，也没有人可以绝对的说自己在整个项目中不会遇到一点问题，不去查东西，自己大脑里的东西完全可以让我把这个项目测测底底的做完，并且没有任何bug。

上班的时间，也没有老板或者谁在后面一直看着你去做东西，大家都挺忙。文档是干嘛的，文档本身就是用来看的，甚至很多项目开始之前，总监都会让你去搜集一些这个项目可能会遇到的bug，可能会用到的效果，尽量在之前找到比较好用的插件，这样会节省很多时间，自己如果写代码的话不可能百分百的确定没有人和bug，但插件不一样很多插件都是前辈通过很长时间慢慢完善出来的插件，所以很多人才会用。所以你提问的可以肯定的回答你允许。

说个我遇到的2个真事吧，

第一个，公司找的外包公司写项目程序，已经要交付了，发现有几个功能没做，产品经理和开发那边都找我，我一个搞运维的又不懂，只能让他们去对开发文档，我也就顺便看了看，开发文档中明确的写明怎么做，然后就让他们就重新按开发文档继续写，

另一个，由于 历史 原因业务系统处于托管状态，只有部分参考文档可用，开发那边只能按当前已有文档进行开发参考，开发那边也一直在根据现有相关文档进行开发，杯具的是这帮子不仔细看，有问题总想着我能直接给他们答案，我也只是会用而已，开发我还真搞不来，然后和他们一起看开发文档，加密算法部分给她们指出后，问题解决了。

所以我觉得，开发团队在开发中很有必要阅读开发文档，这可以避免绕圈子，也会清楚开发文档中提供的内容。

程序员上班的主要工作就是看说明文档，根据说明文档编码。如果实在没有说明文档，有时还得亲自披挂上阵写说明文档。

写接口的有API文档，写通讯协议的有协议字段说明文档，写数据库的有数据库规范文档，

总之任何一个大公司文档扮演的一个至关重要的问题，因为形不成文档，公司管理就会陷入混乱不堪的局面，当某个核心员工离职后，下一个接盘的程序员会丈二和尚摸不着头脑，一头雾水，边填坑边骂娘，有了文档就可以看文档结合代码，了解其中模块逻辑以及结构，包括哪些坑不能踩等等好处。有些公司会专门有文档工程师这个职位来专门负责整理各种文档，并且保存在服务器上。

好的文档都是程序员等人智慧的结晶，是一盏指路明灯，是一条通往光明的道路。程序员不能看说明文档等于在黑暗里摸爬滚打，有了说明文档才迎来了黎明的曙光。

先说观点，我认为看文档没什么问题，但是“大量”这个程度很难衡量，按照需要看文档是个非常重要的事情。

需要花费时间的情况 不需要花费大量时间的情况 小结

在工作中阅读文档其实也是工作内容的一部分，而且现在大多数互联网公司都靠KPI进行考核，平时就算你把时间都用来看文档没关系，最后KPI没完成一样会被公司淘汰。所以公司不会阻拦你花费时间看文档，最多你老板会提醒你浪费这么多时间看文档而没有实际的产出会对你年终考核造成影响罢了。

题主对文档的定义不是很明确

第一个是需求说明文档

这个是在开发过程中必不可少的文档，只有清楚了开发需求，程序员高效率的开发，程序员一天的工作时间并不是都是在写代码，而是在看文档，了解需求，理清思路，只有什么都清楚了，写代码或许只要十几分钟。

再者对于一个项目新人来说不看文档了解需求，没人给你从头到尾的在讲一遍需求，你不看文档自己发挥？进入项目是和别人共同开发，你不肯能不顾及之前的代码规范。

第二个是开发文档

就拿微信开发来说，微信开发不是每个程序员必须会的东西，但是用到了怎么办，还不是去看他们的开发文档，只有将开发文档思路理清楚了，才可以进行下一步开发。

第三个是API文档

在前后端分离的开发模式中API文档是必不可少的文档。不看API不知道数据是什么样。也就是不可能顺利的和后端进行结合。

兄dei，假设你是程序员，你在写程序时，旁边会有人守着你吗？

假设你不是程序员，你在做本职工作时，旁边会有人守着你看你怎么做事吗？

答案肯定是没有的。谁会闲着招个人去监督你，看你用什么方式去完成给你的任务。

现在不管是大公司还是小公司，没有人会在意你怎么去完成你的工作，给你的任务，在很多时候，大家只关注结果。如果说有干预，最多只是实现的方式。像写程序，假设有个功能是即时通讯相关的，这种自己写需要的时间成本投入较高，那么很多公司就会选择采用市面上比较稳定的第三方平台。这算一种实现方式的干预。但是在接入的过程中，不会有人去管你是通过阅读第三方SDK文档，还是谷歌搜出来的，最后能达到预期效果就ok了

所以，其实你看不看大量文档，没有人会在乎，关键是你自己，建议自己写东西时，不要一味的复制粘贴，要有自己的想法。太依赖文档对于自己成长很不利

当然允许看文档。

要知道，随便哪个类库，都有无数的类和方法，每个方法又有若干参数，鬼知道它们都是什么意思，谁的脑子能记得那么多内容。别说是人家提供的类库，就是自己写的代码，过一段时间也不记得什么意思了。没有注释和文档，怎么看懂代码？

如果没有需求分析文档，程序员怎么理解正在开发的这个软件的基本业务流程？

如果没有架构设计文档，程序员怎么理解软件各个功能模块之间的功能与业务逻辑？

如果没有接口文档，那么多类和方法，都怎么调用，会返回什么值，难道靠猜？

……

在日常开发工作中，不仅允许看文档，还会强迫你写文档。如果你写的文档别人看不懂，别怪领导骂你不认真。文档对于软件开发的重要性是不言而喻的。

还有一个秘密告诉你，那些经常写文档的程序员，要比不写文档的程序员工资更高。

真的！！！

迎娶白富美，从会写文档开始！

毫无疑问是的。

对于程序员来说，在实际工作中进行代码编写和项目开发时，是离不开各种各样的文档的。文档包括：

不允许看说明文档，这基本上只会出现在面试或者考试中，为了考察程序员自身的编码能力，才要求脱离参考资料，利用自身的知识和技术来完成。

当然了，程序员工作中也不能只看文档，要是花费大量时间通读不必要的文档，工作可就做不完了。

---