Part 64 End user docs - terrytaylorbonn/auxdrone GitHub Wiki

24.0903

(gdrive) (no docs for this topics yet).

End user doc creation process

I created the core end user docs for almost all projects I have worked. The basic process that I have used (very successfully) is the following:

1 Initial tasks (~first month):

• Create an internal github wiki with access for all.
• Add any existing Quick Start, Getting Started docs (or similar docs).
• Perform hands-on exploration of the target product.
• Create (and publish internally) detailed and accurate (draft WIP) QS/GS docs.

2 Constantly build out the documentation:

• Reorg wiki constantly, adding commentary, corrections.
• After getting sufficient target product experience: Add more docs (User Guide, programming guide, API refs, etc).
• Note: Continue to use Wiki/docx until confident of content and organization for entire doc set.

3 Demo final release doc tools:

• Demo several options.
• Add some of the existing docs.

4 Create a draft WIP doc site:

• Select doc tools.
• Publish.
• Push for feedback from SME's.

5 Constant improvement.