技术文档写作流程

Prepare

1. I need to check targeted audiences, the purpose of the document, the type of the document, any duplicate information that are already there or not. For example a troubleshooting method to enable customer self-assistance.

2. I need to do some investigation by searching, learning from others and testing in our lab environment. Normally, developers will give us some reference documents.

3. I need to evaluate the workload and decide how many people should join the work and how long it needs.

4. Then I make the detailed schedule and architecture.

Write

1. Follow the format specifications to ensure consistent style, right wordings, and grammer. 

2. Ensure information is well-organized and logistically reasonable.

3. We need to ensure the technically details are complete enough and totally accurate.

Review

1. After I have finished the draft topic, I check it first by

- using Arcolinx, an expensive topic checker.

- reading the topic again and gain to ensure the topic is right and easy to understand.

- peer review.

2. Then I send the topic to developers for review. I may get feedback and modify my topic. Then send to developers until they said it's ok to publish the topic.

Publish

1. Add the topic to TOC.

2. Use automatic tools such as GitHub to submit and use Jenkins to publish to pre-production KC.

3. Ensure no errors and warnings on Jenkins result.

4. Ensure the topic is showed well on the pre-production KC.

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 我的个人博客 http://yedingding.com 会更新 Teahour.fm 的最新音频文本,欢迎关注。...
    叶玎玎阅读 1,044评论 0 2
  • Leonid Rogozov was a Soviet general practitioner who took...
    马文Marvin阅读 1,000评论 0 1
  • 爸爸是个浪漫的人。 六岁那年暑假,爸爸外出去北京。一连好几天(我也不知道几天)那会儿心心念念他早点回家,满心期待他...
    黄小号阅读 364评论 0 1
  • 2-3 个性化消息: 将用户的姓名存到一个变量中,并向该用户显示一条消息。显示的消息应非常简单,如“Hello E...
    七一欧阅读 409评论 0 5
  • 我终其一生离不开黑白,年轻的时候,不是黑就是白,要不就是混搭,黑白配。 随着年龄的增长,我开始偏向白色,不管...
    白玄子阅读 347评论 1 5