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.