Skip to content

Principle 2: One document, one purpose

Each document answers one question and addresses one audience. If your title needs "and", split it.

Signs Your Document Needs Splitting

  • Title contains "and" (example: "Deployment and Monitoring")
  • Document covers multiple audiences or use cases
  • File feels overwhelming to read in one sitting
  • Logical sections could stand alone as separate topics

Example

Bad: DevOps-Guide.md (too broad, many audience types)

Good: how-to-deploy.md, how-to-rollback.md, monitoring-architecture.md