Bluebook Maintenance
Contribution Guide
Contributions should make the blue book easier to apply in real engagements. Prefer practical guidance, examples, and checklists over abstract essays.
Good contributions
Good contributions usually:
- Fill a repeated engagement gap.
- Clarify a decision or tradeoff.
- Add a reusable template or checklist.
- Replace stale guidance with current practice.
- Link related pages into a clearer path.
- Capture lessons from incidents, audits, or migrations.
Page structure
Most guidance pages should include:
- Short purpose statement.
- When to use it.
- Practical checklist or workflow.
- Outputs or evidence expected.
- Watchouts.
- Links to related pages where useful.
Writing style
- Use direct language.
- Keep recommendations actionable.
- Avoid vendor hype.
- Prefer defaults with exceptions over vague neutrality.
- Use synthetic examples only.
- Avoid sensitive client details.
Pull request checklist
Before merging, confirm:
- Page has a clear owner or maintainable scope.
- Links work.
- Guidance does not conflict with existing pages.
- Markdown formatting passes.
- New pages are added to the correct
meta.json. - Sensitive data is not included.
Watchouts
- Do not add a new page when an existing page should be improved.
- Do not copy client-specific artifacts without sanitizing them.
- Do not introduce new terminology without updating the glossary.