Technical documentation should be how to write

For developers: business model code

1. Participation Guidelines

2. Code style

3. Architecture Design

4. design

5. implementation details

6. code review

7. code integration

8. deployed on the line

9. stepped pit Guide

10.FAQ

 

User-oriented: class library, the code the frame type

1. Get the code

2. Quick Start

3. Use demo

4. Interface Description

5. Module Description

6. Advanced Topics (a architecture design;. B best practices;. C compare competing products.)

7.FAQ

 

Document Management:

confluence, Google Docs, git or some other self doc management platform

Recommend learning to use Markdown

Guess you like

Origin www.cnblogs.com/biang/p/11671871.html