Epic 6 Project management - terrytaylorbonn/auxdrone GitHub Wiki

24.0914

This epic is a WIP.

At this point you've learned the basic skills for building Ziptie AI drones. You've

• Built and flown a drone (epics 1-2)
• Added AI and autonomy (epics 3-5)

This epic 6 (Gdrive) differs from epics 1-5 in that it focuses mainly on project management and end customer support topics. I describe these topics from my own conceptual framework of how they fit in with ZiptieAI drone building.

I go into a lot of detail about API documentation (see part (63) #2-4 below) because I've done a lot of API documentation in the past. My previous projects were not public, so here I demo various techniques for creating and publishing API docs.

This epic focuses on the following topics:

• (61) Project planning/docs (cms+conf/jira).
  • Writing basic project plan docs (for a specific mission platform).
  • Using a CMS (content management system).
  • Using Conflluence/Jira.
• (62) Git.
  • Storing on Git.
  • Versioning (branches, merge).
  • Teamwork (Github).
• (63) API/SDK docs. *********************
  • #0 Configure API server platform and #1 Build API. The basics of creating APIs and using ("consuming") APIs.
  • #2 Generate front/backend "contract" docs (swagger, graphQL schema). Documenting how to use an API.
  • #3 Publish "contract" docs (Swagger, API description to web). Publishing the API docs to a web server.
  • #4 Test (using Postman, Swagger, etc.).
  • #5 Create / document SDKs.
• (64) End user (dev) docs. User Guides, Quick Starts, wikis, etc. Such docs that I have written in recent years have all been confidential, so I will post basic examples/templates.