如何写技术文档

第一篇：如何写技术文档

如今，软件开发越来越复杂，软件功能也越来越丰富。而几乎所有成熟的商业软件，都是靠一个开发团队齐心协力的血汗结晶。“罗马不是一天建成的！”，当我们震撼于MicrosoftWindows的惊世巨著的同时，也道听途说了微软公司软件工程是如何的完善规范。的确，集数百名员工几年的共同努力之大成，软件项目管理的成败是控制开发成本的关键环节。这里面，少不了贯穿其中的重要步骤----软件文档。

软件文档可以分为开发文档和产品文档两大类。

开发文档包括：《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。

产品文档包括：《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、《技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、《用户报告》、《销售培训》等。

一、开发文档

1.《功能要求》--来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。

2.《投标方案》--根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写《投标方案》，方案书一般包括以下几个重要的章节：

前言--项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。

需求分析--项目要求、软件结构、功能列表、功能描述、注意事项等。

技术方案--总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。

项目管理--描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。

技术支持--公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术

服务区域、技术服务期限、授权用户联系人等。

系统报价--软、硬件平台报价列表、软件开发费用、系统维护费用等。

项目进度--整个项目的进度计划，包括签署合同、项目启动、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。

3.《需求分析》--包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。以《功能要求》为基础，进行详细的功能分析(包括客户提出的要求和根据开发经验建议的功能)，列出本产品是什么，有什么特殊的概念，包括那些功能分类，需要具备什么功能，该功能的操作如何，实现的时候该注意什么细节，客户有什么要求，系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。

4.《技术分析》--包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以《需求分析》为基础，进行详细的技术分析(产品的性能和实现方法)，列出本项目需要使用什么技术方案，为什么，有哪些技术问题要解决，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。

5.《系统分析》--包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以《需求分析》为基础，进行详细的系统分析(产品的开发和实现方法)，估计开发期间需要把什么问题说明白，程序员根据《系统分析》，开始在项目主管的带领下进行编码。

6.《数据库文档》--包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以《系统分析》为基础，进行详细的数据库设计。必要时可以用图表解说，特别是关系数据库。

7.《功能函数文档》--包括变量名、变量初植、功能，函数名，参数，如何调用、备注、注意事项等。以《系统分析》为基础，进行详细的说明，列出哪个功能涉及多少个函数，以便以后程序员修改、接手和扩展。

8.《界面文档》--包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求，这里与软件完成后的运行界面是一致的。

9.《编译手册》--包括服务器编译环境、操作系统、编译工具、GNU的C++编译器版本信息、目录说明、程序生成、源程序文件列表、Makefile配置及其相关程序的对应关系列表。客户端的编译过程、编译结果、编译示例、编译环境、操作系统、编译工具、源文件列表和制作安装程序的过程。

10.《QA文档》--包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要求等，提供给软件测试人员使用。

11.《项目总结》--包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。

二、产品文档

1.《产品简介》--包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公司联系地址。

2.《产品演示》--包括公司简介、产品背景、产品描述、产品特点、产品作用、适用范围、使用分析、功能模块、解决问题、合作伙伴、成功案例等。一般用Powerpoint或者VCD录制软件实现。

3.《疑问解答》--列出用户关心的问题和处理方法。用于解答软件的操作功能和解决用户的疑难问题。

4.《功能介绍》--以《需求分析》为书写基础，包括软件介绍、软件结构、功能列表、功能描述和公司联系地址。

5.《技术白皮书》--以《技术分析》为书写基础，包括功能实现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向等。

6.《评测报告》--第三方权威评测报告。包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。

7.《安装手册》--包括系统环境、运行平台、产品安装过程、初始环境设置、安装记录等。

8.《使用手册》--包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等。

9.《维护手册》--包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份、技术问题解答和联系方式等。

10.《用户报告》--包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等。

11.《销售培训》--包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、目标客户等。

第二篇：学技术

2014学什么技术最好就业？最能赚钱？

近年来，随着各大高校不断扩招，我国毕业生的就业形势日益严峻。每年新增的数百万大学生，给整个社会带来严峻考验。然而，不少人力资源负责人观察到，很多求职者咨询职位时，第一句话是问工资待遇怎么样，而不是介绍自己具备哪些技能。

“很多人提出的工资要求与现在的社会形势存在差距，把自己抬得太高了。”一位公司的HR介绍说。除此以外，在场的HR们还发现，很多人对自己未来的职业没有明确目标，不清楚自己想要什么样的生活，对自己也没有明确的定位，很迷茫。

面对史上最难就业年，如果毕业生们还是眼高手低的话，前程将一片灰暗。所以，想要在众多求职者中占到先机，首先要对自己有清晰的定位。这就要求高校毕业生们对自己的能力、特长以及优缺点有正确的认识，对于自己以后要从事什么行业、未来几年的发展都要有规划。其次，把眼光放开一些，不要一味坚持与自己专业相符的职业，如果没有合适的，可以尝试其他行业。最好选择有前景自己感兴趣的行业。另外，不要浮躁，沉淀下来。不能让社会去适应自己，而应该让自己学会去适应社会;不要总想着企业能为自己带来什么，要去想想自己能为企业带来什么。如果自己的能力达不到企业的要求，就要想办法进行提高和再培训。

谈到怎样才能挣大钱?学什么技术才能挣大钱?2014年学什么技术好?分析利弊，山东新东方烹饪学院推荐学厨师，学烹饪。餐饮业是我国第三产业服务业中的重点行业，中国是烹饪大国，饮食文化影响全世界，誉满全球。近年来餐饮业经济持续快速增长，餐饮行业发展水平稳步提升，厨师的社会地位也愈发高涨，薪资待遇更是水涨船高，许多餐饮行业更是出现“一厨难求”的情况。再者，学厨师门槛低，回报高，无需学历、无需技能，只要认真学，就能学业有成，就能高薪就业!

当你还在为学什么好就业而发愁的时候，已经有很多学烹饪技能的年轻人们走上了康庄大道。所以，任何行业抢占先机最重要，现在正是学厨师的好机会，要抓住机遇，迎接挑战，未来才能更精彩。《新华网》报道

第三篇：技术

4．软件测试的实施

1）单元测试

对模块进行测试，用于发现模块内部的错误

2）集成测试

测试和组装软件的过程，主要用于发现与接口有关的错误。

集成测试包括的内容：软件单元的接口测试、全局数据结构测试、边界条件和非法输入的测试等。

集成测试分为：增量方式组装（包括自顶而下、自底而上、自顶向下和自底向上的混合增量方式）与非增量方式组装。

3）确认测试

验证软件的功能和性能及其他特征是否满足了需求规格说明中确定的各种需求，以及软件配置是否完全、正确。

4）系统测试

将经过测试后的软件，与计算机的硬件、外设、支持软件、数据和人员等其他元素组合在一起，在实际运行环境中进行一系列的集成测试和确认测试。

（五）程序的调试

1．基本概念

程序调试活动包括：根据错误的迹象确定程序中错误的确切性质、原因和位置；对程序进行修改，排除错误。

1）基本步骤

进行回溯测试，防止引进新的错误。修改设计和代码，以排除错误

错误定位

2）程序调试的原则

（1）确定错误的性质和位置

分析与错误有关的信息

避开死胡同

调试工具只是一种辅助手段，只能帮助思考，不能代替思考

避免用试探法

（2）修改错误的原则

在出现错误的地方，有可能还有别的错误，在修改时，一定要观察和检查相关的代码，以防止其他的错误

一定要注意错误代码的修改，不要只注意表象，而要注意错误的本身，把问题解决

注意在修正错误时，可能代入新的错误，错误修改后，一定要进行回归测试，避免新的错误产生

修改错误也是程序设计的一种形式

修改源代码程序，不要改变目标代码

2．软件调试方法

1）强行排错法

通过内存全部打印来排错

在程序特定部位设置打印语句—即断点法

自动调试工具。

2）回溯法

适合小规模程序的排错。发现错误，分析错误表象，确定位置，再回溯到源程序代码，找到错误位置或确定错误范围。

3）原因排除法

原因排除法包括：演绎法、归纳法和二分法。

演绎法：是一种从一般原理或前提出法，经过排除和精化的过程来推导出结论的思考方法。

归纳法：从一种特殊推断出一般的系统化思考方法。其基本思想是从一些线索着手，通过分析寻找到潜在的原因，从而找出错误。

二分法：如果已知每个变量在程序中若干个关键点的正确值，则可以使用定值语句在程序中的某点附近给这些变量赋值，然后运行程序并检查程序的输出。

三、例题分析

1．选择题

1）软件开发的需求活动，其主要任务是

A）给出软件解决方案

B）给出系统模块结构

C）定义模块算法

D）定义需求并建立系统模型

【答案】D

2）软件可用性意指

A）用户界面友好的程度

B）软件结构、实现及文档为用户可用的程度

C）修改软件错误的难易程度

D）符合用户使用习惯的程度

【答案】B

3）软件过程是

A）特定的开发模型

B）一种软件求解的计算逻辑

C）活动的集合D）软件生存周期模型

【答案】D

4）需求分析阶段的任务是确定

A）软件开发方法

B）软件开发工具

C）软件开发费

D）软件系统的功能

【答案】D

5）软件测试方法中的静态测试方法之一为

A）静态结构分析

B）黑盒法

C）路径覆盖

D）边界值分析

【答案】A

6）可行性研究要进行一次什么类型的需求分析

A）详细的 B）全面的

C）简化的、压缩的 D）彻底的【答案】C

7）软件开发过程中，抽取和整理用户需求并建立问题域精确模型的过程叫

A）生存期

B）面向对象设计

C）面向对象程序设计

D）面向对象分析

【答案】D

8）原型化方法是一种什么型的设计过程

A）自外向内 B）自顶向下

C）自内向外 D）自底向上

【答案】A

9）为了提高测试的效率，应该__________。

A）随机地选取测试数据

B）取一切可能的输入数据作为测试数据

C）在完成编码以后制定软件的测试计划

D）选择发现错误可能性大的数据作为测试数据

【答案】D

10）使用白盒测试方法时，确定测试数据应根据什么和指定的覆盖标准。

A）程序的内部逻辑

B）程序的复杂结构

C）使用说明书

D）程序的功能

【答案】A

2．填空题

1）软件工程的基本原则包括抽象、信息隐蔽、模块化、局部化、确定性、__________和__________。

【答案】完备性 可验证性

2）系统流程图是描述物理模型的传统工具，用图形符号表示系统中各个元素表达了系统中各种元素之间的__________情况。

【答案】信息流动

3）详细设计的任务是确定每个模块的内部特性，即模块的算法、__________。

【答案】使用的数据

4）所有软件维护申请报告要按规定方式提出，该报告也称__________报告。

【答案】软件问题

5）软件测试过程一般包括4个步骤，即单元测试、集成测试、验收测试（确认测试）和__________。

【答案】系统测试

四、小结

通过本章的学习，要求了解软件工程的基本概念；了解软件工程过程与软件的生命周期，以及软件工程的目标和原则；了解利用结构化分析法进行软件工程中的需求分析的方法，并了解需求分析的方法和需要完成的任务；了解数据流图的使用方法；了解如何利用结构化设计方法进行软件设计，并了解软件设计的一些常用工具；了解软件测试的目的和方法，以及软件测试的准则，了解常用的软件测试方法的区别和各自的功能与特点；了解程序调试的方法和原则。

公共基础知识笔记：

2011年计算机二级公共基础知识辅导讲义汇总

2011年全国计算机等级考试二级公共基础知识要点汇总

2011年全国计算机等级考试二级公共基础知识总结汇总

公共基础知识试题：

2011年全国计算机等级考试二级公共基础知识复习题

全国计算机等级二级公共基础知识考前练习汇总

全国计算机二级考试公共基础知识习题

全国计算机等级考试二级公共基础知识

第四篇：技术文档

ID所有人变更申请表

双方单位用户加盖公章_________________________

(个人用户附身份证明复印件，新版身份证附正反两面)

第五篇：通用技术

通用技术教学工作总结

（2011-2012学第二学期）

本学期我担任了高一通用技术的教学工作，以下将根据我的教学工作实践谈谈我的体会。

一、课前：认真备课，认真准备，尽可能地熟悉教材，做足充分准备。

二、做好课后工作。认真批改作业，分析并记录学生的作业情况，将他们在作业过程出现的问题作出分类总结，进行透切的评讲，并针对有关情况及时改进教学方法，做到有的放矢。但是还有少部分同学抄袭别人的作业，针对这种问题，就要抓好学生的思想教育，并使这一工作惯彻到对学生的学习指导中去，还要做好对学生学习的辅导和帮助工作。

三、平时在教学上，有疑必问，在各个章节的学习上都搜索很多资料，学习前辈们的教学方法。积极参与听课、评课，虚心向同行学习，博采众长，并邀请其他老师来听课，征求他们的意见，改进工作。培养多种兴趣爱好，到图书馆或上网博览群书，不断扩宽知识面，为教学内容注入新鲜血液。

四、自制教具渲染教学色彩

《通用技术》新课程要上得好，上得生动、精彩，要求我们的教师对教材必须深刻理解，能根据教材内容的理念选用教具与学具或亲手制作教具，这是一个非常重要的教学手段。因为这是教学中的精髓，它能帮助教师保质保量完成教学任务，提高学生对这门课程的兴趣，通过教师的范例可以更好的帮助学生开拓设计思维大门，增强学生创新、设计制作的信心、激活学生对技术的情感，使他们投身本课程的学习。

五、存在的问题。《通用技术》课是新开设的课程，还没有专门的实验室；知识结构还不是很完整；还需要对两本书的知识点进行彻底的分析，把它们联系起来，这些都有待以后改进。

在接下来的教学和工作中，我会更加努力，更加勤奋。

李彦涛 2012年7月