#Documentation Templates

Templates for creating new documentation in the Eko repository.

---

#Available Templates

Template	Purpose	Target Directory
architecture.md	Architecture documentation	docs/architecture/
dev-guide.md	Developer guides	docs/dev/
product.md	Product documentation	docs/product/
runbook.md	Operational runbooks	docs/runbooks/
spec.md	Technical specifications	docs/specs/
README.md	Section index pages	Any docs/*/ directory
fix-report.md	Bug fix reports	docs/reports/fixes/
feature-report.md	Feature update reports	docs/reports/features/
proposal.md	Design proposals	docs/proposals/

---

#Usage

#Using docs:new Script

# Create a new document from template
bun run docs:new --scope <scope> --title "Title"

# List available scopes
bun run docs:new --list-scopes

#Manual Creation

1. Copy the appropriate template
2. Rename using kebab-case: YYYY-MM-DD-short-description.md (for updates/proposals)
3. Replace {{TITLE}} and {{DATE}} placeholders
4. Fill in the sections

---

#Template Variables

Variable	Description	Example
{{TITLE}}	Document title	"Render Worker Auto-Wake"
{{DATE}}	Creation date (YYYY-MM-DD)	"2026-01-01"

---

#Related Documents

• Documentation Conventions
• Reports
• Proposals