科技文档写作实务

结合大量案例进行深入浅出的说明，既有综合性描述又从正反案例进行剖析，具有针对性和应用性。 中兴通讯学院拥有业界优选的文档开发系统、流程和规范, 培养了国内一批技术文档职业从业者，从事写作的20余名文档专家们是中兴通讯学院从文档写作团队中遴选出来的文档精英，沉淀了他们丰富的文档写作经验。 案例对读者在科技论文写作、企业工作中间有直接借鉴作用。

《科技文档写作实务》以“理论+实战”的方式，帮助读者在短时间内掌握科技文档写作要领，提高职场竞争力。全书系统地阐述了技术文档的概念、写作流程、质量要素及技术文档的写作方法。为了帮助读者更好地掌握这些原理，《科技文档写作实务》针对实际工作中经常使用到的需求说明书、概要设计、软件模块详细设计、测试用例、使用指导和故障处理进行专题介绍，从内容框架、写作过程、写作实例、写作要点和常见问题进行了详细说明。《科技文档写作实务》既可作为产品研发和测试人员、售后支持人员及用户文档开发人员的培训参考用书，也可作为高等院校的教学用书。

国家体育总局青少年体育司是国家体育总局直属单位，其主要职责是指导和推进青少年体育工作，拟订青少年体育工作的有关政策、规章、制度和发展规划草案，指导和推动青少年体育服务体系建设和指导开展青少年体育工作研究和相关培训等。 国家体育总局体育科学研究所是国家体育总局直属、科技部保留和发展的重量、多学科、综合性的社会公益类体育科研事业单位，其主要任务是引领和推动我国体育科技事业发展，把握国际体育科学前沿领域和未来体育事业发展中的重大科技问题，以国民体质监测和健身方法研究、优秀运动员竞技能力研究、体育政策研究、体育工程技术研究等领域为主要方向开展基础研究和应用研究，为我国群众体育、竞技体育和体育产业的可持续发展及提高国际竞争力提供科技支持和服务。

1概述篇1
1.1什么是技术文档2
1.1.1技术文档的定义2
1.1.2技术文档的范畴2
1.1.3技术文档的特征4
1.1.4技术文档的多种形式4
1.2技术文档写作的国际国内现状5
1.3技术文档写作的重要意义6
2基础篇7
2.1技术文档写作流程8
2.1.1需求分析9
2.1.2架构设计10
2.1.3文档写作10
2.1.4质量控制11
2.1.5文档发布12
2.1.6文档交付12
2.1.7文档维护12
2.2需求分析13
2.2.1信息收集13
2.2.2简化归类15
2.2.3分析需求18
2.2.4确定文档开发任务20
2.3架构设计21
2.3.1架构前的准备和学习21
2.3.2设计架构22
2.3.3架构检查25
2.4文档写作26
2.4.1写作的逻辑26
2.4.2写作6步法28
2.4.3写作黄金法则28
2.5质量控制31
2.5.1质量控制活动31
2.5.2高质量文档三要素34
3进阶篇37
3.1实用性38
3.1.1安全第 一39
3.1.2内容准确41
3.1.3面向任务45
3.1.4合理组织49
3.1.5内容完整58
3.2可读性61
3.2.1易读62
3.2.2易理解75
3.3舒适性85
3.3.1文档获取便捷86
3.3.2内容检索高效87
3.3.3阅读感受舒适92
4实战篇101
4.1如何写需求说明书102
4.1.1需求说明书简介102
4.1.2需求说明书内容框架102
4.1.3需求说明书写作流程104
4.1.4需求说明书写作实例106
4.1.5需求说明书写作要点111
4.1.6需求说明书常见问题111
4.2如何写概要设计文档112
4.2.1概要设计文档简介112
4.2.2概要设计文档内容框架113
4.2.3概要设计文档写作流程114
4.2.4概要设计文档写作实例117
4.2.5概要设计文档写作要点121
4.2.6概要设计文档常见问题121
4.3如何写软件模块详细设计文档123
4.3.1软件模块详细设计文档简介123
4.3.2软件模块详细设计文档内容框架123
4.3.3软件模块详细设计文档写作流程124
4.3.4软件模块详细设计文档写作方法125
4.3.5软件模块详细设计文档写作要求131
4.4如何编写测试用例144
4.4.1测试用例简介144
4.4.2测试用例内容框架144
4.4.3测试用例写作流程146
4.4.4测试用例写作实例148
4.4.5测试用例写作要点152
4.4.6测试用例常见问题152
4.5如何写使用指导文档155
4.5.1使用指导文档简介155
4.5.2使用指导文档内容框架155
4.5.3使用指导文档写作流程156
4.5.4使用指导文档写作实例157
4.5.5使用指导文档写作要点171
4.5.6使用指导文档常见问题171
4.6如何写故障处理文档173
4.6.1故障处理文档简介173
4.6.2故障处理文档内容框架173
4.6.3故障处理文档写作流程174
4.6.4故障处理文档写作实例177
4.6.5故障处理文档写作要点179
4.6.6故障处理文档常见问题179
5附录 主题类型183
5.1概念(Concept)184
5.2任务(Task)185
5.3参考(Reference)186