21.3 Api docs - terrytaylorbonn/auxdrone GitHub Wiki

24.0830

End user docs

End user doc creation process

For system without organized existing docs.

1 First month or 2...

• Create an internal github wiki with access for all
• Add existing Quick Start, Getting Started docs
• Hands on exploration of product, creating accurate, WIP, detailed QS/GS docs

2 Get back system expertise, concepts...

• Reorg wiki constantly, adding other docs that found
• As get to know the system: Add concepts, User Guide, etc
• Stick to Wiki/docx until confident of how it all needs to be organized for first release draft

3 Demo final release doc tools

• Demo several options
• Add some of the existing docs

4 Select tools and create a quick draft doc release for sanity check

API doc basic process

create an api (or fork one).

go thru all the swagger gen + doc options.

for python / c#.

• api + swagger + web
  • python
    • demos
      • xxhttps://www.geeksforgeeks.org/swagger-ui/#
      • https://www.geeksforgeeks.org/implement-a-python-rest-api-with-flask-flasgger/
      • https://swagger.io/blog/api-development/automatically-generating-swagger-specifications-wi/
    • FORK github.com/rlabbe/filterpy/tree/master docu
    • add stuff to create swagger
    • import swagger into
      • gitbook
  • c#