Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 1.05 KB

File metadata and controls

30 lines (20 loc) · 1.05 KB

Docs Module

Use this module to seed a project with documentation that explains what the project is, how to run it, how it is designed, how it changes, and how others can contribute.

Read First

  1. README.template.md
  2. SETUP.template.md
  3. ARCHITECTURE.template.md
  4. ROADMAP.template.md
  5. CONTRIBUTING.template.md

Fill These First

  • Project name and one-sentence description.
  • Installation and local development commands.
  • Current architecture summary.
  • Near-term roadmap.
  • Contribution expectations.

Documentation Rule

Every doc should answer one practical question. If a document does not change what a reader can do, sharpen it or remove it.

Related Modules