科技文档写作实务

(副标题)：无 ;

(作者): 中兴通讯学院 ;

内容简介：

​

序言

进入21世纪以来，科学技术日新月异，产品技术换代节奏加快，产品复杂性、集成化、智能化程度越来越高。新产品的开发通常涉及系统、硬件、软件甚至器件、元件和材料等方方面面；异地协同完成开发和加工制造的情况也很普遍；生产外包和服务外包更是需要企业内外的合作；产品的最佳效能需要在正确使用和维护中才能体现；用户对产品的功能和性能及使用方法的了解是关键。产品从创意到使用，涉及概念、计划、开发、验证、发布、运营维护等诸多环节，信息化产品在使用中往往还需要远程监控和联网软件升级。产品需要全生命周期的管理，贯穿其中的是科技文档，依靠科技文档实现在不同环节的知识传递和产品价值链的耦合，在企业与市场间架起桥梁。

一般来说，产品科技文档分为研发文档（需求说明书、概要设计、详细设计文档、测试用例文档）和用户文档（使用指导文档和故障处理文档）。不同的科技文档对应产品生命周期的不同阶段，面向不同对象的读者；不同的产品其科技文档的专业不同，但这并不意味着科技文档的随意性。好的科技文档要求明确、定义严谨、指标具体、方法直观、简洁规范、善用图表、易读而无歧义、可操作、可检验。但不少企业重技术产品的开发和生产，却轻文档的写作与管理，常常会面临文档之痛，即文档质量及管理滞后于产品，文档价值没有深入挖掘, 知识没有得到及时固化；文档没有建立有效的传递渠道，甚至伴随人员流失而造成知识断档；更为严重的是可能引起产品的法律纠纷。这些都额外增加了企业内外沟通及运营成本。

科技文档写作的水平不仅反映了企业发展的成熟度，也是企业国际化水平的标志之一。高端国际市场对于科技文档的要求极为挑剔。国际大企业十分重视科技文档工作，微软、IBM、思科等在产品科技文档上下了很大工夫。在国际上，科技文档写作作为一个研究领域已经经过多年发展，目前已形成了完整的理论体系，例如Darwin Information Typing

目录预览：

​ 科技文档写作实务
目录
扉页
版权
序言
编者序
前言
1 概述篇
1.1 什么是技术文档
1.1.1 技术文档的定义
1.1.2 技术文档的范畴
1.1.3 技术文档的特征
1.1.4 技术文档的多种形式
1.2 技术文档写作的国际国内现状
1.3 技术文档写作的重要意义
2 基础篇
2.1 技术文档写作流程
2.1.1 需求分析
2.1.2 架构设计
2.1.3 文档写作
........