技术的写作
技术写作一般分为5个步骤:
1.1 做好准备
包括确定此次技术写作要达到的主要目标;评估受众/读者的信息需求;决定技术写作范围多大;选择适当的写作媒介。
1.2 调研
通过现场调查、电话、会议、研讨、图书馆和互联网搜集相关信息,并且认真做好记录。
1.3 信息的组织
对调研阶段收集的杂乱无章、不连贯的信息,按一定的索引形式进行整理和组织。对信息组织的方式可能形成各自不同的习惯方式。
1.4 具体写作
先写出文档大纲,再把大纲扩展成段落,第一份草稿不要担心语法和语言的精练或标点符号。
1.5 精炼修改
检查草稿,看是否能准确完整和有效地达到目标和满足读者需要。多读几次草稿,每次寻找和纠正不同的问题和错误。首先集中在大的问题上,如统一和连贯性问题;留下机械式的纠正工作(如拼写和标点符号)放在后面的校订中。对于重要文档,要考虑请其他人来审查文档并提出改进建议。