doc-template.md

Documentation Template (Operational)

Use this template when adding a new operational or engineering document under docs/.

Keep sections that apply; remove non-applicable placeholders before merging.

---

1. Summary

• Purpose:
• Audience: <operators | reviewers | contributors | maintainers>
• Scope:
• Non-goals:

2. Prerequisites

• <required tools/config>

3. Procedure

3.1 Baseline Check

3.2 Main Workflow

3.3 Verification

• <validation command/log/checkpoint>

4. Safety, Risk, and Rollback

• Risk surface:
• Failure modes:
• Rollback plan: <concrete rollback command/steps>

5. Troubleshooting

• Symptom: <error/signal>
  • Cause:
  • Fix:

6. Related Docs

• README.md — documentation taxonomy and navigation.
• <related-doc-1.md>
• <related-doc-2.md>

7. Maintenance Notes

• Owner: <team/persona/area>
• Update trigger:
• Last reviewed: