Skip to content

Documentation Standards

How we document our work at Nheo.

Rules

  • Every project gets a folder under projects/
  • Document decisions, not just steps
  • Write for someone who wasn't in the room
  • Use clear headings and avoid walls of text
  • Include the Linear project link at the top of project docs

Minimum Documentation Per Project

Every project doc must cover at minimum:

  1. What the project does
  2. Why we built it this way (key design decisions)
  3. How to run and maintain it
  4. Known issues or limitations