Wiki

When starting a new project, assert following items are documented on the project's wiki.

  • What's the project about? Write a brief overview.
  • Link important documents (Tech Stack, UML diagrams, etc).
  • Document design pattern decisions.
  • Document the main data models and relationships.
  • Document business logic.
  • Create and link diagrams describing complex flows.
  • Document common support issues and how to solve them.
  • Document important guides:
    • Quality Assurance
    • Downtime recovery
    • Tasks monitoring
    • Deploy