Skip to main content

Documentation Templates

Reference templates for creating consistent wiki documentation. AI agents and contributors should use these templates when adding new content.

Available Templates​

TemplateUse For
ServiceDocumenting a service/component
RunbookOperational procedures
TroubleshootingIssue diagnosis guides
TutorialEnd-to-end usage guides
ADRArchitecture decisions

Guidelines​

File Naming​

  • Use kebab-case: My-Service-Name.md
  • Be descriptive: PostgreSQL-Backup-Runbook.md not backup.md

Linking​

  • Use relative links: [Related](/docs/AI-ML-Platform/norns-agent)
  • Link to index pages: [Features](/docs/Features/)

Structure​

  • Start with H1 title matching filename
  • Include overview/purpose first
  • Use tables for reference data
  • Include Related section at bottom

Content Placement​

Content TypeLocation
New service docsFeatures/platform-name/
Infrastructure componentsInfrastructure/
Operational proceduresRunbooks/category/
Diagnostic guidesTroubleshooting/ or Troubleshooting/By-Service/
How-to guidesTutorials/
Architecture decisionsArchitecture/Decisions/
Quick referenceReference/