科技文档写作实务 - (EPUB全文下载)

文件大小：8.13 mb。
文件格式：epub 格式。
书籍内容：

目录
封面
扉页
版权
序言
编者序
前言
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 文档写作
2.1.4 质量控制
2.1.5 文档发布
2.1.6 文档交付
2.1.7 文档维护
2.2 需求分析
2.2.1 信息收集
2.2.2 简化归类
2.2.3 分析需求
2.2.4 确定文档开发任务
2.3 架构设计
2.3.1 架构前的准备和学习
2.3.2 设计架构
2.3.3 架构检查
2.4 文档写作
2.4.1 写作的逻辑
2.4.2 写作6步法
2.4.3 写作黄金法则
2.5 质量控制
2.5.1 质量控制活动
2.5.2 高质量文档三要素
3 进阶篇
3.1 实用性
3.1.1 安全第一
3.1.2 内容准确
3.1.3 面向任务
3.1.4 合理组织
3.1.5 内容完整
3.2 可读性
3.2.1 易读
3.2.2 易理解
3.3 舒适性
3.3.1 文档获取便捷
3.3.2 内容检索高效
3.3.3 阅读感受舒适
4 实战篇
4.1 如何写需求说明书
4.1.1 需求说明书简介
4.1.2 需求说明书内容框架
4.1.3 需求说明书写作流程
4.1.4 需求说明书写作实例
4.1.5 需求说明书写作要点
4.1.6 需求说明书常见问题
4.2 如何写概要设计文档
4.2.1 概要设计文档简介
4.2.2 概要设计文档内容框架
4.2.3 概要设计文档写作流程
4.2.4 概要设计文档写作实例
4.2.5 概要设计文档写作要点
4.2.6 概要设计文档常见问题
4.3 如何写软件模块详细设计文档
4.3.1 软件模块详细设计文档简介
4.3.2 软件模块详细设计文档内容框架
4.3.3 软件模块详细设计文档写作流程
4.3.4 软件模块详细设计文档写作方法
4.3.5 软件模块详细设计文档写作要求
4.4 如何编写测试用例
4.4.1 测试用例简介
4.4.2 测试用例内容框架
4.4.3 测试用例写作流程
4.4.4 测试用例写作实例
4.4.5 测试用例写作要点
4.4.6 测试用例常见问题
4.5 如何写使用指导文档
4.5.1 使用指导文档简介
4.5.2 使用指导文档内容框架
4.5.3 使用指导文档写作流程
4.5.4 使用指导文档写作实例
4.5.5 使用指导文档写作要点
4.5.6 使用指导文档常见问题
4.6 如何写故障处理文档
4.6.1 故障处理文档简介
4.6.2 故障处理文档内容框架
4.6.3 故障处理文档写作流程
4.6.4 故障处理文档写作实例
4.6.5 故障处理文档写作要点
4.6.6 故障处理文档常见问题
5 附录 主题类型
5.1 概念（Concept）
5.2 任务（Task）
5.3 参考（Reference）
科技文档写作实务
■中兴通讯学院　编著
人民邮电出版社
北京
图书在版编目（CIP）数据
科技文档写作实务/中兴通讯学院编著.--北京：人民邮电出版社，2013.8
ISBN　978-7-115-32074-2
Ⅰ.①科…　Ⅱ.①中…　Ⅲ.①科学技术—应用文—写作　Ⅳ.①H152.3
中国版本图书馆CIP数据核字（2013）第151637号
内容提要
本书以“理论+实战”的方式，帮助读者在短时间内掌握科技文档写作要领，提高职场竞争力。全书系统地阐述了技术文档的概念、写作流程、质量要素及典型技术文档的写作方法。为了帮助读者更好地掌握这些原理，本书针对实际工作中经常使用到的需求说明书、概要设计、软件模块详细设计、测试用例、使用指导和故障处理进行专题介绍，从内容框架、写作过程、写作实例、写作要点和常见问题进行了详细说明。
本书既可作为产品研发和测试人员、售后支持人员及用户文档开发人员的培训参考用书，也可作为高等院校的教学用书。
◆编著　中兴通讯学院
责任编辑　李静
责任印制　杨林杰
◆人民邮电出版社出版发行　　北京市崇文区夕照寺街14号
邮编　100061　　电子邮件　315@ptpress.com.cn
网址　http://www.ptpress.com.cn
北京隆昌伟业印刷有限公司印刷
◆开本：700×1000　1/16
印张：12.5　　2013年8月第1版
字数：211千字　　2013年8月北京第1次印刷
定价：39.00元
读者服务热线：(010)67119329　印装质量热线：(010)67129223
反盗版热线：(010)67171154
序言
进入21世纪以来，科学技术日新月异，产品技术换代节奏加快，产品复杂性、集成化、智能化程度越来越高。新产品的开发通常涉及系统、硬件、软件甚至器件、元件和材料等方方面面；异地协同完成开发和加工制造的情况也很普遍；生产外包和服务外包更是需要企业内外的合作；产品的最佳效能需要在正确使用和维护中才能体现；用户对产品的功能和性能及使用方法的了解是关键。产品从创意到使用，涉及概念、计划、开发、验证、发布、运营维护等诸多环节，信息化产品在使用中往往还需要远程监控和联网软件升级。产品需要全生命周期的管理，贯穿其中的是科技文档，依靠科技文档实现在不同环节的知识传递和产品价值链的耦合，在企业与市场间架起桥梁。
一般来说，产品科技文档分为研发文档（需求说明书、概要设计、详细设计文档、测试用例文档）和用户文档（使用指导文档和故障处理文档）。不同的科技文档对应产品生命周期的不同阶段，面向不同对象的读者；不同的产品其科技文档的专业不同，但这并不意味着科技文档的随意性。好的科技文档要求明确、定义严谨、指标具体、方法直观、简洁规范、善用图表、易读而无歧义、可操作、可检验。但不少企业重技术产品的开发和生产，却轻文档的写作与管理，常常会面临文档之痛，即文档质 ............

书籍插图：

以上为书籍内容预览，如需阅读全文内容请下载EPUB源文件，祝您阅读愉快。