技术写作流程
技术写作流程如下:
- 准备阶段:理解用户、分析任务、学习产品。
- 理解用户:了解用户的知识水平和工作场景,以确定文档的难易度。
- 分析任务:了解用户工作中需要完成哪些任务,哪些任务最重要、最费时、最费事,以确定文档的顺序和重点。
- 学习产品:学习产品的功能,并理解这些功能和用户工作内容之间的关系。做产品的第一个用户,先自己学会,然后教会用户。
-
写作和修改阶段:通常情况下,写作人员很难一次性写出完美的文档。高质量的文档源自反复的修改。
- 审稿阶段:审稿通常由同行同事和产品总负责人完成。他们会提供表达、结构、技术上的意见和建议。根据这些建议修改之后,文档的终稿就产生了。