程序说明文档.doc

程序说明文档 1.熟悉项目发生的相关业务行为。 言下之意,就是说:我们要做的是什么项目2.将业务,从产品层面肢解开来,做到抽丝剥茧部分与整体统一 很笼统的说.程序说明文档1经历1个多月的时间，软件工程视频和相关文档学习已近尾声，每个人都有不同程度的收获吧，来看看我的感受如何：通过对软工视频的学习，已了解软工视频大致是在为写文档做预习，一个软件工程必不可少的一部分就是文档的编辑，文档亦难亦不难。不难在我们都能理解每一份文档，并且知道每份文档主要内容有什么，而难亦在怎么将文档的主要内容写出来，用什么表示主要内容，可以让读者更清晰的了解你需要表达什么内容。通过一次文档的验收，暴露了我们很多问题，即使写的再详细，由于我们缺少经验，总是或多或少的存在某些问题。比如，对于可行性研究报告主要给要看这份文档的人指出项目开发的实际效益，主要从技术与经济方面，而我的文档中掺杂着一些详细到具体功能的描述，这个是需求或者详细设计文档中的内容，从而使可行性研究报告过于赘余，其他文档也都存在这样的一些问题。下面我来好好的总结下每份文档中都主要该有什么内容吧。程序说明文档21.一般项目的开始，我要交代好要解决的问题，和自己的解题思路。目的是让其他人在接触项目的时候能够了解到我的意图，而不必花时间乱猜。2.说清楚你怎么构建整个项目，每一个目录下的文件是干什么的，配置在哪里。你曾经为这个项目画过什么样的图来辅助你的开发和思考。3.你写了哪些测试用例，怎么运行你的测试用例，什么样的结果是复合预期的。4.如果是一个第三方库，一定要带例子，越详细越好。5.关于某些功能，你是如何思考，如何取舍的。6.根据别人的反馈不断地更新文档。7.写好引用。最后，写文档比写代码难多了。程序说明文档31.一般项目的开始，我要交代好要解决的问题，和自己的解题思路。目的是让其他人在接触项目的时候能够了解到我的意图，而不必花时间乱猜。2.说清楚你怎么构建整个项目，每一个目录下的文件是干什么的，配置在哪里。你曾经为这个项目画过什么样的图来辅助你的开发和思考。3.你写了哪些测试用例，怎么运行你的测试用例，什么样的结果是复合预期的。4.如果是一个第三方库，一定要带例子，越详细越好。5.关于某些功能，你是如何思考，如何取舍的。6.根据别人的反馈不断地更新文档。7.写好引用。最后，写文档比写代码难多了。程序说明文档4程序说明书是对程序流程图进行注释的书面文件，以帮助程序设计人员进一步了解程序的功能和设计要求。它是程序流程图的配套文档，也是处理流程设计的配套文档。程序说明书由系统设计人员编写，交给程序设计人员使用。因此，程序说明书必须写得清楚明确，使程序设计人员增加对所要设计的程序的处理过程和设计要求的理解。 1程序说明书包括如下七个内容：1.程序名称;包括反映程序功能的文字名称和标识符。2.程序所属的系统、子系统或模块的名称。3.编写程序所需使用的语言。4.输入的方式和格式：当程序有多种输入时，分别对每种输入方式与格式做出具体而细致的说明。5.输出的方式与格式：当程序有多种内容按不同方式输出时，分别说明不同内容按不同方式输出时的格式。6.程序处理过程说明：包括程序中使用的计算公式，数学模型和控制方法等。7.程序运行环境说明：对程序运行所需要的输入输出设备的类型和数量，计算机的内存及硬盘容量，支持程序运行的操作系统等内容进行说明。程序说明文档5话说我们每次做项目的文档也都bai不太一样我大概描述下我两年前的一个文du档吧(在邮箱里找到的)1.项目概述：项目名称：项目用途：2.需求分析业务需求用户需求功能需求性能需求3. 系统功能模型4.系统设计4.1 总体设计4.2 详细设计4.2.1 系统的结构模型程序说明文档