软件工程文档都包括哪些?
有很多,有几个是很重要的如:需求规格说明书,概要设计说明书,详细设计说明书,记不太清了,还有什么立项调查报告、立项建议书、立项评审报告、项目设计开发任务书、项目计划、软件评审报告、变更需求报告、设计变更报告、项目管理报告、项目总结报告等;本人建议你还是去找一本软件工程的书籍来看一下!自己看一下比较好!我说的也不够清楚!
软件文档可以分为哪两大类?
软件文档从形式上来看,大致可分为两类: 一类是开发过程中填写的各种图表,可称之为工作表格;另一类是应编制的技术资料或技术管理资料,可称之为文档或文件.
程序员的技术文档都写些什么内容啊?谢谢~
技术文档当然就是写你会什么技术. 会什么语言,用什么语言开发过什么软件或网站. 学这门语言多久了,做个网站要多久. 也就这样了.
怎样写好软件文档
正文如下：
我不知道是不是有人会将阅读或书写技术文档当做爱好。虽然很讨厌这样做，但是通常为了解决问题或介绍一个技术产品，我们不得不去做这些事情。要想写好文档很难。技术文档有几种形式：基本概览，高级概览，一步一步的演示，自动生成的文档，等等。考虑下不同用户对你的文档的需求情况：不同的需求，不同的技术，不同的学习风格。你将会发现，没有一种格式能同时适应所有人。受众情况在写项目文档的时候，你首先要考虑到的是读者。最终用户首先需要的是一份入门指南。尽管一些技术概念可能会提到，但是重点应放在用户界面，而不是后台。如果是程序员，他可能会想得到更多的信息：程序运行原理，代码的实现，怎样对代码进行扩展，等等。为部分用户写的文档不应当影响到另一部分用户的阅读，你可以考虑写两份单独的文档，用户使用手册和技术文档。几种不同类型的文档 Jacob Kaplan-Moss在他的怎样写好文档的指南中，他提到了三种文档：教程，专题指南和参考指南。
教程：教程是很重要的，因为这往往是用户在使用新的工具时得到的第一印象。我们之前写到过，有许多不同的工具可以帮你写好教程。如果你想写的话，Kaplan-Moss建议你写得简单快速一些，但是不要太简单了，可以做一个演示，为每一步骤添加相关的截图。专题指南：Kaplan-Moss说这是文档的主要内容。虽然教程提供了一个高层次的概念，但是专题指南可以让感兴趣的人深入学习，内容一定要详尽。Kaplan-Moss提到，一般来说，图书要胜过官方文档，但是后者的一个优点是随时更新。参考指南：参考指南是为那些已经入门但是还需要更多信息的用户准备的。为那些已经知道怎样使用API，但是需要查找确切的函数参数或详细设置信息的用户定制的。要指出的是，参考指南是无法由教程和普通指南替代的。自动生成的文档只能起一个引导作用，如果没有额外的写作，编辑和组织，它是不可能解决大家的问题的。虽然这是“技术写作”，但是这并不意味着你应该放弃文采，语法和拼写检查。至少得检查一下语法和拼写吧。
软件开发流程文档有那些?
需求确认——概要设计——详细设计——编码——单元测试——集成测试——系统测试——维护 需求确认:需求规格说明书 概要设计:系统用例图,用例场景 详细设计:系统设计报告,数据库设计报告 测试:测试用例报告
软件开发的技术实现文档要怎么写
很多额,比如 1.开发背景 2.可行性分析 3.硬件环境 4.概要设计 5.详细设计 6.数据库设计 7.测试报告 等
软件工程中需要多少文档
最基本的:立项文档,需求分析文档,概要设计和架构设计、详细设计、源代码、配置文档、单元测试文档、集成测试文档、验收文档、维护文档、用户操作手册、项目管理文档.具体的因每个公司每个项目会有不同.
软件开发项目中，过程管理文档都包括什么？
在软件项目开发过程中，应该按软件开发要求撰写十三类文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性！
需求阶段
1、可行性分析报告
说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。
2、项目开发计划
为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。
3、软件需求说明书（软件规格说明书）
对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。
设计阶段
4、概要设计说明书
该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。
5、详细设计说明书
着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。
开发阶段
6、开发进度月报
该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。
测试阶段
7、测试计划
为做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。
8、测试分析报告
测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。
收尾阶段
9、用户操作手册
本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。
10、项目开发总结报告
软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。
11、软件维护手册
主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明，便于软件的维护。
维护阶段
12、软件问题报告
指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软
件修改提供准备文档。
13、软件修改报告
软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。
国标软件开发设计报告,或软件开发技术报告的模板
软件开发环境(Software Development Environment，SDE)是指在基本硬件和宿至软件的基础上，为支持系统软件和应用软件的工程化开发和维护而使用的一组软件，简称SDE。它由软件工具和环境集成机制构成，前者用以支持软件开发的相关过程、活动和任务，后者为工具集成和软件的开发、维护及管理提供统一的支持。
SDE在欧洲又叫集成式项目支援环境（Integrated Project Support Environment，IPSE）。
软件开发环境的主要组成成分是软件工具。人机界面是软件开发环境与用户之间的一个统一的交互式对话系统，它是软件开发环境的重要质量标志。存储各种软件工具加工所产生的软件产品或半成品（如源代码、测试数据和各种文档资料等）的软件环境数据库是软件开发环境的核心。工具间的联系和相互理解都是通过存储在信息库中的共享数据得以实现的。
软件开发环境数据库是面向软件工作者的知识型信息数据库，其数据对象是多元化、带有智能性质的。软件开发数据库用来支撑各种软件工具，尤其是自动设计工具、编译程序等的主动或被动的工作。
较初级的SDE数据库一般包含通用子程序库、可重组的程序加工信息库、模块描述与接口信息库、软件测试与纠错依据信息库等；较完整的SDE数据库还应包括可行性与需求信息档案、阶段设计详细档案、测试驱动数据库、软件维护档案等。更进一步的要求是面向软件规划到实现、维护全过程的自动进行，这要求SDE数据库系统是具有智能的，其中比较基本的智能结果是软件编码的自动实现和优化、软件工程项目的多方面不同角度的自我分析与总结。这种智能结果还应主动地被重新改造、学习，以丰富SDE数据库的知识、信息和软件积累。这时候，软件开发环境在软件工程人员的恰当的外部控制或帮助下逐步向高度智能与自动化迈进。
软件实现的根据是计算机语言。时至今日，计算机语言发展为算法语言、数据库语言、智能模拟语言等多种门类，在几十种重要的算法语言中，C&C++语言日益成为广大计算机软件工作人员的亲密伙伴，这不仅因为它功能强大、构造灵活，更在于它提供了高度结构化的语法、简单而统一的软件构造方式，使得以它为主构造的SDE数据库的基础成分——子程序库的设计与建设显得异常的方便。
事实上，以C&C++为背景建立的SDE子程序库能为软件工作者提供比较有效、灵活、方便、友好的自动编码基础，尤其是C++的封装等特性，更适合大项目的开发管理和维护。
软件开发环境可按以下几种角度分类：
(1)按软件开发模型及开发方法分类，有支持瀑布模型、演化模型、螺旋模型、喷泉模型以及结构化方法、信息模型方法、面向对象方法等不同模型及方法的软件开发环境。
(2)按功能及结构特点分类，有单体型、协同型、分散型和并发型等多种类型的软件开发环境。
(3)按应用范围分类，有通用型和专用型软件开发环境。其中专用型软件开发环境与应用领域有关，故又软件开发方法(Software Development Method)是指软件开发过程所遵循的办法和步骤。软件开发活动的目的是有效地得到一些工作产物，也就是一个运行的系统及其支持文档，并且满足有关的质量要求。软件开发是一种非常复杂的脑力劳动，所以经常更多讨论的是软件开发方法学，指的是规则、方法和工具的集成，既支持开发，也支持以后的演变过程(交付运行后，系统还会变化，或是为了改错，或是为了功能的增减)。
关于组成软件开发和系统演化的活动有着各种模型(参见软件生存周期，软件开发模型，软件过程)，但是典型地都包含了以下的过程或活动：分析、设计、实现、确认(测试验收)、演化(维护)。
有些软件开发方法是专门针对某一开发阶段的，属于局部性的软件开发方法。特别是软件开发的实践表明，在开发的早期阶段多做努力，在后来的测试和维护阶段就会使费用较大地得以缩减。因此，针对分析和设计阶段的软件开发方法特别受到重视。其它阶段的方法，从程序设计发展的初期起就是研究的重点，已经发展得比较成熟(参见程序设计，维护过程)。除了分阶段的局部性软件开发方法之外，还有覆盖开发全过程的全局性方法，尤为软件开发方法学注意的重点。
对软件开发方法的一般要求：当提出一种软件开发方法时，应该考虑许多因素，包括：①覆盖开发全过程，并且便于在各阶段间的过渡；②便于在开发各阶段中有关人员之间的通信；③支持有效的解决问题的技术；④支持系统设计和开发的各种不同途径；⑤在开发过程中支持软件正确性的校验和验证；⑥便于在系统需求中列入设计、实际和性能的约束；⑦支持设计师和其他技术人员的智力劳动；⑧在系统的整个生存周期都支持它的演化；⑨受自动化工具的支持。此外，在开发的所有阶段，有关的软件产物都应该是可见和可控的；软件开发方法应该可教学、可转移，还应该是开放的，即可以容纳新的技术、管理方法和新工具，并且与已有的标准相适应可称为应用型软件开发环境。
⑷按开发阶段分类，有前端开发环境(支持系统规划、分析、设计等阶段的活动)、后端开发环境(支持编程、测试等阶段的活动)、软件维护环境和逆向工程环境等。此类环境往往可通过对功能较全的环境进行剪裁而得到。软件开发环境由工具集和集成机制两部分构成，工具集和集成机制间的关系犹如“插件”和“插槽”间的关系。
工具集：软件开发环境中的工具可包括：支持特定过程模型和开发方法的工具，如支持瀑布模型及数据流方法的分析工具、设计工具、编码工具、测试工具、维护工具，支持面向对象方法的OOA工具、OOD工具和OOP工具等；独立于模型和方法的工具，如界面辅助生成工具和文档出版工具；亦可包括管理类工具和针对特定领域的应用类工具。
集成机制：对工具的集成及用户软件的开发、维护及管理提供统一的支持。按功能可划分为环境信息库、过程控制及消息服务器、环境用户界面三个部分。
环境信息库：是软件开发环境的核心，用以储存与系统开发有关的信息并支持信息的交流与共享。库中储存两类信息，一类是开发过程中产生的有关被开发系统的信息，如分析文档、设计文档、测试报告等；另一类是环境提供的支持信息，如文档模板、系统配置、过程模型、可复用构件等。
过程控制和消息服务器：是实现过程集成及控制集成的基础。过程集成是按照具体软件开发过程的要求进行工具的选择与组合，控制集成并行工具之间的通信和协同工作。
环境用户界面：包括环境总界面和由它实行统一控制的各环境部件及工具的界面。统一的、具有一致视感(Look & Feel)的用户界面是软件开发环境的重要特征，是充分发挥环境的优越性、高效地使用工具并减轻用户的学习负担的保证。
较完善的软件开发环境通常具有如下功能：
(1)软件开发的一致性及完整性维护；
(2)配置管理及版本控制；
(3)数据的多种表示形式及其在不同形式之间自动转换；
(4)信息的自动检索及更新；
(5)项目控制和管理；
(6)对方法学的支持。
软件开发的需求文档要具备哪些要素，格式如何？
需求文档的编写内容包括很多的，但是需要根据该软件的规模和具体要求进行编写。 一份比较完整的详细需求分析应该包括：1. 前言 2. 摘要 3. 系统详细需求分析 3.1. 详细需求分析 3.1.1. 详细功能需求分析 3.1.2. 详细性能需求分析 3.1.3. 详细信息需求分析 3.1.4. 详细资源需求分析 3.1.5. 详细组织需求分析 3.1.6. 详细系统运行环境及限制条件需求分析 3.1.7. 信息要求 3.1.8. 性能要求 3.2. 接口需求分析 3.2.1. 系统接口需求分析 3.2.2. 现有软、硬件资源接口需求分析 4. 总体方案设计4.1. 系统总体结构 4.1.1. 系统组成、逻辑结构 4.1.2. 应用系统结构 4.1.3. 支撑系统结构 4.1.4. 系统集成 4.1.5. 系统工作流程
.2. 分系统详细界面划分 4.2.1. 应用分系统与支撑分系统的详细界面划分 4.2.2. 应用分系统之间的界面划分 5. 应用分系统详细设计 5.1. XX分系统详细需求分析 5.1.1. 功能详细需求分析 5.1.2. 性能详细需求分析 5.1.3. 信息详细需求分析 5.1.4. 限制条件详细分析 5.2. XX分系统结构设计及子系统划分 5.3. XX分系统功能详细设计 5.4. 分系统界面设计 5.4.1. 外部界面设计 5.4.2. 内部界面设计 5.4.3. 用户界面设计 6. 数据库系统设计 6.1. 设计要求 6.2. 信息模型设计 6.3. 数据库设计 6.3.1. 数据访问频度和流量 6.3.2. 数据库选型 6.3.3. 异构数据库的连接与数据传递方式
6.3.5. 数据共享方式设计 6.3.6. 数据安全性及保密设计 6.3.7. 数据字典设计
8. 信息编码设计 8.1. 代码结构设计 8.2. 代码编制 9. 关键技术 9.1. 关键技术的提出 9.2. 关键技术的一般说明 9.3. 关键技术的实现方案 10. 系统配置 10.1. 硬件配置 10.2. 软件配置 11. 限制 12. 组织机构及人员配置 12.1. 机构调整与确认 12.2. 组织机构的任务和职责 12.3. 人员配置方案 12.4. 培训计划 13. 工程实施计划 13.1. 分期实施内容 13.2. 进度计划 13.3. 实施条件 13.4. 测试与验收 14. 投资预算 15. 参考和引用资料
16. 术语
这里还有很需要补充的，也有很多是可以不写的；因为一份需求文档不是谁能写的，呵呵，在实际的工作中
是那些负责人才能写这个的。如果是课设的话，只要在流程图 逻辑结构 或者是XX分系统的设计图上下点功夫就好了。说到格式 就是按上面的写 然自己弄一个目录 就像是我们平时翻书的时候看到的那种，这样好阅读。
