Skill for creating technical documents in the correct project structure.
Creation Process
Step 1: Look for existing docs structure
Check whether docs/ and its subfolders exist.
Step 2: Determine category
If subfolders exist in docs/: offer them as options.
If subfolders do not exist, ask the user:
| Category | Use |
|---|---|
specs/ |
Feature/system specifications |
planning/ |
Active implementation plans |
archive/ |
Completed or superseded documents |
architecture/ |
ADRs, architectural decisions |
reference/ |
Technical reference documentation |
backlog/ |
Pending features, future ideas |
work-in-progress/ |
Active work documentation |
Step 3: Generate file name
Format: YYYY-MM-DD-<feature-name>.md
- Use current date (without time)
<feature-name>in kebab-case, descriptive, no spaces- Exception: ADRs use
NNNN-<name>.md(sequential number)
Step 4: Create the document
- Create subfolder if it does not exist
- Read and apply the corresponding template from
references/:- Spec:
references/spec-template.md - Plan:
references/plan-template.md - ADR:
references/adr-template.md - Reference:
references/reference-template.md
- Spec:
- Write file in the correct location
Resources
To see complete examples of each document type, read the files in references/:
| Type | Template | Example |
|---|---|---|
| Spec | references/spec-template.md |
references/spec-example.md |
| Plan | references/plan-template.md |
references/plan-example.md |
| ADR | references/adr-template.md |
references/adr-example.md |
| Reference | references/reference-template.md |
references/reference-example.md |