Skip to content

Documentation Standards

Date Rule

Remove dates from filenames, visible headings, indexes, generated metadata, and runbook body content.

Use logical event order instead of date order.

Incident Format

# Short Incident Title

## Summary
Briefly explain what happened and why it mattered.

## Environment
List relevant systems, services, hosts, VMs, containers, storage, and network details.

## Problem
Describe symptoms, errors, and impact.

## Timeline
Document the sequence of events without relying on dates.

## Investigation
Describe what was checked and what was found.

## Resolution
Explain what fixed the issue.

## Validation
Show how the fix was confirmed.

## Lessons Learned
Capture reusable takeaways.