科技文档写作实务读书笔记

治白癜风中药 http://news.39.net/bjzkhbzy/171219/5943334.html

笔者简介

李源原:英语(电子信息工程)专业背景;获得PMP和CATTI认证;资深技术文档工程师;10年技术传播行业经验,从事文档开发、咨询与团队管理,产品涉及IT、电信、机械电子、汽车、化工等领域。曾就职于科多思公司上海分公司。

-----------------------------------------------------

由于职业病作祟,先读了下内容提要,了解到本书的目标读者应该是入门或初级从业水平,所以在阅读时也假设自己是此类读者。

首先,不得不说,作为中兴通讯的内训教程,本书的确编写得很好:阐述清晰、详尽(如2.2.1.2)、由浅至深,针对性可操作性较强(如第3篇的质量要素表),并引用大量实例(如2.2.2、表2-13和第4篇)、方便读者理解和参照。对于一个初学者来说,从阅读本书入手,可以对技术写作有个大致的掌握,对其它行业的文档写作也可以起到较好的参照作用。

另外,国内一直没有关于技术传播行业的书籍,非常开心看到本书填补了这个空白。其实很多业内人士已经认识到了应该有一些教材类的书籍,便于该行业的交流、研究和人才培养。但是,想到不等于做到,会做不等于会教。真正把想法落实到行动上不是件容易的事情。从本书中,我看到了编写者的热情、毅力、行业沉淀与社会责任。

以下为阅读过程中的一些个人想法和疑问,如有冒昧,敬请编者原谅:

1.关于用词一致:●书名:发现书名里用的是“科技文档”一词,而前言和第1篇的目录采用的是“技术文档”。而且,前言把“科技文档”分为“科研文档”和“技术文档”两类,但实际上本书大部分都在谈“技术文档”。所以个人觉得,如果书名用“技术文档”会不会更好些?●“写作”与“开发”:“2.1技术文档写作流程”中采用“写作”一词,而正文中使用“开发”一词。●P46第二行“根据读者对象确定文档定位”与“3.1.3.1根据读者对象设计任务”不一致。●“表3-2可读性的质量要素”:“标题反映主题”应为“标题反映主题思想”。●“3.2.2易理解”:“举例增加理解”应为“举例增强理解”;“标题反映中心思想”应为“标题反映主题思想”,以保持与表3-2(P62)、3.2.2.3的一致。●P86的质量表:“采用可识别的文字”应为“采用易识别的文字”,以保持和3.3.2的一致。

2.笔误:●“3.1.2.2保持信息的一致性”中的“原文”举例:两处数据中均为“mm”,并无不一致的现象;另外“物理指标”部分的虚线框包含“(高x宽x深)”,而“产品外观”部分的虚线框却不包含,建议改成一致。●P49的两个例子中“确订”应为“确定”。●P49的第二个例子中(2)“硬件要求”应为“软件要求”。

3.P78第一个截图和P99截图中出现了光标,建议去除。

4.本书的初衷是作为企业内训材料,因此内容和架构方面都是以此为出发点的。但是如果计划将来再版时扩充读者范围,是否考虑添加以下内容?●对技术文档的定义和解释再详细具体些●技术文档开发流程中各个角色的分工和相应技能要求,以方便读者深入了解与自检,并形成自己的职业发展计划。●一些公司采用的是文档集/库(library)的概念,即把所有产品文档都放在一个大的库集里面,因此任何文档的新增、修改、删减等操作都和整个文库内容和架构的关系非常密切,而文档库架构的设计也直接影响其中每个文档的定位、架构和内容。而且,对文库历史问题(legacyproblem)的改善、或者从宏观的文库角度来处理文档的历史问题,也是很多公司文档部门(或通过邀请专业的信息分析师、信息架构师等)的职责之一。因此,是否考虑适当补充文档集/库相关内容?目前本书的内容基本都是围绕单一文档在谈。●市场类技术文档的相关内容,比如产品技术宣传册等。当然,如果把此类文档理解成面向潜在用户的文档,也可以将其归为广义的用户文档一类。但是个人理解,市场类文档与书中所指的的用户文档区别之一是,市场类文档主要用于销售和售前,如果用书中图1-2说明的话,对应的是产品生命周期中从概念到发布前的阶段。因此有必要特别说一下。另外,也有人把市场类文档划入文案写作范畴(copywriting)而非技术文档范畴。个人理解,文案似乎可以按照用途分为两类,用于市场的文案(copywritingformarketingpurpose)和用于广告的文案(copywritingforadvertisementpurpose),而市场类文档好像就应该归在市场文案一类。但是一些专业文档服务公司把市场类文档归为技术写作范畴、把市场文档开发也作为服务项目之一,而把文案写作狭义地理解成广告文案一类,因为市场类技术文档和广告在某些方面又有所不同,这种做法好像也说得通。笔者接触过市场类文档一段时间,但是完全没有广告文案的实践经验,所以还请这一块的专家多多分享。●“2.4文档写作”是否可以多些内容、更细化些,因为初学者可能更加


转载请注明:http://www.aierlanlan.com/rzdk/1081.html