Documentation Notes
===

This is a "meta" document about the process of writing
documentation.

Four Types of Documentation
---

[src](https://www.divio.com/blog/documentation/)

* Tutorials
  - learning oriented (lessons)
  - let user learn by doing
* How-To Guides
  - goal oriented
  - shows how to solve a specific problem
* Explanation
  - understanding oriented
  - provided history, background and context
* Reference
  - information oriented
  - accurate and complete
  - assumes knowledge about motivation and structure of project

Outline of Documentation for Popufare
---

I'm having trouble differentiating "Learning" from "How-to".
Maybe the "Learning" category should be more about broader
topics that only tangentially relate to Popufare and "How-tos"
should be specific on how to get aspects of Popufare working.

* How-to
  - How to setup a test server and test DIU
    + How to setup a test database
    + How to setup a test server/Docker image
    + How to setup a test docker bus fare image (separate from the server)
  - How to Setup a DIU and PIU hardware system
  - How to customize the Popufare system for your own organization
* Reference
  - Ridelogic/Popufare API
  - Popufare Database tables
  - DIU services
    + billing local database description
    + passes local database description
  - Port mapping
* Explanation
  - Give overview of project and what each of the components does and how they
    interact
  - This is where larger diagrams go and high level overview comes in

References
---

* [divio.com Documentation](https://www.divio.com/blog/documentation/)
