Loading...
Loading...
Documentation-as-code conventions for team repos. Defines a docs/ taxonomy (ADR, RFC, guide, system, incident, audit), naming rules, templates, and boundaries. Use when creating, moving, or organizing documentation files.
npx skill4agent add usedilver/skills docs-conventionsdocs/
adr/ # Architecture Decision Records — immutable once accepted
rfcs/ # Proposals under discussion — accepted, rejected, or superseded
guides/ # How-to guides for the team
systems/ # Technical documentation of current systems
incidents/ # Postmortems and investigations
audits/ # Inventories and point-in-time analysis| Directory | Pattern | Example |
|---|---|---|
| | |
| | |
| | |
| | |
| | |
| | |
docs/adr/# NNNN. Title
**Date:** YYYY-MM-DD
**Status:** Accepted | Superseded by [NNNN](link)
## Context
What is the issue that we're seeing that motivates this decision?
## Decision
What is the change that we're proposing and/or doing?
## Consequences
What becomes easier or more difficult to do because of this change?docs/rfcs/# NNN. Title
**Date:** YYYY-MM-DD
**Status:** Draft | In Discussion | Accepted | Rejected
**Author:** name
## Summary
One-paragraph description of the proposal.
## Motivation
Why are we doing this? What problem does it solve?
## Proposal
Detailed description of the proposed change.
## Alternatives Considered
What other approaches were evaluated and why were they rejected?
## Open Questions
Unresolved issues that need team input.docs/guides/docs/systems/docs/incidents/# YYYY-MM-DD: Title
**Severity:** Critical | High | Medium | Low
**Status:** Resolved | Mitigated | Monitoring
**Duration:** start — end
## Summary
What happened in 2-3 sentences.
## Impact
Who/what was affected and to what extent.
## Timeline
Chronological list of events.
## Root Cause
Why it happened.
## Resolution
What was done to fix it.
## Action Items
- [ ] Preventive measuresdocs/audits/ls docs/adr/ | sort -n | tail -1 # Next ADR number
ls docs/rfcs/ | sort -n | tail -1 # Next RFC numberdocs/docs/mkdir -p docs/{adr,rfcs,guides,systems,incidents,audits}
touch docs/adr/.gitkeep