技术写作三步走的细化工作流
技术写作三步走的详细操作手册。
”第一步素材积累“阶段
- 选定文章标题
- 只是选定标题,不去过分限制角度
- 也不用着急写中心句
- 读各种技术文档
- 这个阶段,只是去形成段落
- 不用考虑文章结构,也不用考虑部分结构
“第二步整理论述逻辑”阶段
- 逐步形成每个段落的标题
- 段落标题(用列表的一级缩进表示即可)下面是展开论述和例证
- 不能展开,没有例证的观点,不能形成段落,最终可以直接删除
- 形成部分标题( markdown 的二级标题 )
- 文档读完,要形成八九个清晰的段落
- 现在就可以给段落排序,组织到部分标题之下了
- 注意,是在文档读完之后,才去开始形成部分,此前一定要保证,每个段落内部已经结构清晰了,不需要再调整了
“第三步一气呵成文章”阶段
- 文章中心句和结语现在再写,保证能 cover 住所有部分的标题。
- 部分的中心句和结语也现在再写,保证能 cover 住自己的各个段落的内容。