Skip to content
Back to skills

Docs Architect

ASecurity

Project documentation system — a folder-per-doc-type docs/ tree (ADRs, backlog, ideas, plans, designs, reviews, changes, guides), mandatory frontmatter, lifecycle by moving files, backlog as a queue or as one file per item, weekly/monthly routine, and a stdlib linter. Scaffold, write-doc and migrate modes. Use when setting up docs/, writing a plan/design/ADR/review, triaging a backlog, or reorganizing an existing docs folder.

  • 4 stars
  • 0 votes
  • 0 copies
  • 1 view
  • Added November 7, 2026
developmentpythongogitdocumentation

Works with

  • cli

Security analysis

A100/100

Pro scans all 7 files and shows the line behind each finding

Scanned November 7, 2026

npx -y skills add ralvarez-ai/ralvaskills --skill docs-architect --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Docs Architect?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Docs Architect
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/ralvarez-ai-docs-architect/badge)](https://www.skillsdirectory.com/skills/ralvarez-ai-docs-architect)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: docs-architect
version: 1.2.0
description: Project documentation system — a folder-per-doc-type docs/ tree (ADRs, backlog, ideas, plans, designs, reviews, changes, guides), mandatory frontmatter, lifecycle by moving files, backlog as a queue or as one file per item, weekly/monthly routine, and a stdlib linter. Scaffold, write-doc and migrate modes. Use when setting up docs/, writing a plan/design/ADR/review, triaging a backlog, or reorganizing an existing docs folder.
---

# Docs Architect

A `docs/` convention where **the folder is the doc type, the frontmatter is the state, and moving a file is a state change**. One source of truth per item and per decision. Companion to [grill-with-docs](../grill-with-docs/SKILL.md) (owns `CONTEXT.md` and the ADR *threshold*) and [feature-planner](../feature-planner/SKILL.md) (produces the plans this tree stores). Schemas in [FRONTMATTER.md](FRONTMATTER.md), backlog rules in [BACKLOG.md](BACKLOG.md) (two layouts: a list per project, or one file per item), templates in [TEMPLATES.md](TEMPLATES.md), the classify/migrate procedure in [MIGRATION.md](MIGRATION.md).

Suggestion-mode: the tree is a default. Adopt the folders a project actually needs.

## 1. Modes

- **Scaffold** — no `docs/` yet. Create `docs/README.md` and `docs/templates/`; create every other folder lazily, when its first doc exists.
- **Write-doc** — pick the folder by the doc's job ([§2](#2-where-a-doc-goes)), copy the template, fill the frontmatter, link it to its origin.
- **Migrate** — a `docs/` exists in another shape. Classify, propose moves and renames, wait for approval, then move ([MIGRATION.md](MIGRATION.md)).

## 2. Where a doc goes

| Folder | Job | Name | Edited after writing? |
|---|---|---|---|
| `adr/` | One decision: context, options, decision, consequences | `0001-slug.md` | Body never; `status` and `superseded_by` only |
| `ideas/` | Not yet a plan | `YYYY-MM-DD-project-topic.md` | Yes, while `draft` |
| `plans/` | Scope, phases, exit criteria | dated | Yes |
| `designs/` | How it is built; links ADRs instead of repeating them | dated | Yes |
| `reviews/` | Findings of one review or audit — a snapshot | dated | No |
| `changes/` | What changed and why — migrations, impact | dated | No |
| `guides/` | Current procedures and runbooks | `topic.md` | Yes, always current |
| `methodology/` | Working rules and standards | `topic.md` | Yes |
| `backlog/` | A queue (`inbox.md`, `<project>.md`, `done/YYYY-MM.md`) or one file per item (`project.md`, `pending/`, `active/`, `done/`, `archive/`) | see [BACKLOG.md](BACKLOG.md) | Yes |
| `archive/` | Finished or obsolete | keeps its name | No |

`guides/` and `methodology/` are living documents and carry no date; everything else describes a moment and does. Reviews and changes are history — never rewrite them, add a new one.

## 3. Flow

1. Capture in `backlog/inbox.md`, one line, no format.
2. Weekly triage: drop it, move it to a project backlog, or grow it in `ideas/`.
3. A mature idea becomes a plan with scope and exit criteria.
4. The plan yields a design; each non-trivial decision becomes an ADR.
5. The approved design leaves linked items in the backlog: `Next` in the queue layout, `pending/` in the item layout. Reviews and changes feed new backlog items, each linked to its origin.
6. On close the item moves to `done/YYYY-MM.md`; the doc becomes `status: done`, then moves to `archive/`.

## 4. ADRs

- One decision per ADR, one page: Context, Options considered, Decision, Consequences.
- Numbering is sequential and never reused. Take the next number by scanning `adr/`.
- Whether something deserves an ADR is decided by the three-part test in [ADR_FORMAT.md](../grill-with-docs/ADR_FORMAT.md) (hard to reverse, surprising, real trade-off). This skill adds the mandatory frontmatter and the supersede mechanics on top of it.
- Changing a decision: write a new ADR with `supersedes: N`, then set the old one to `status: superseded` and fill its `superseded_by`.- ADRs are cross-cutting: a decision spanning projects uses `project: global`. Keep `adr/` flat — the number already orders it.
- Designs link ADRs (`[ADR 0002](../adr/0002-slug.md)`) instead of restating the reasoning.

## 5. Links and frontmatter

Every doc except `README.md`, `inbox.md` and `templates/` carries frontmatter ([FRONTMATTER.md](FRONTMATTER.md)): `status`, `project`, `date`, `related`. ADRs use their own schema.

- Use **relative markdown links** (`../adr/0003-slug.md`). They resolve on GitHub, in editors and for agents. Wikilinks only if the project already standardises on an Obsidian-style vault.
- `related` lists paths relative to `docs/`. A doc nothing links to is an orphan; the linter reports it.

## 6. Routine

| When | What | Time |
|---|---|---|
| Daily | Capture in `inbox.md` | 0 |
| Weekly | Triage the inbox; review what is next (`Next` or `pending/`) | 10 min |
| Monthly | Prune what has not moved, close to `done/`, archive obsolete, promote or delete drafts older than 2 months | 15 min |

A backlog item that has not moved for 2–3 months is deleted or demoted (`Later` → `Someday` in the queue layout, `archive/` with `resolution: dropped` in the item layout) — prune, don't archive. If the project tracks work in GitHub Issues, the backlog lives there and only the docs stay here.

## 7. Scale rules

- A per-project subfolder inside a type (`designs/<project>/`) only after ~10 files of that type. Never for `adr/`.
- Several repos: `docs/` per repo by default; a central docs repo only when projects cross-reference heavily. Then `project:` is mandatory and filters the views.
- Keep `CLAUDE.md` / `AGENTS.md` short and pointing at `docs/` — snippet in [TEMPLATES.md](TEMPLATES.md#agent-pointer-section). Do not duplicate the conventions there.

## 8. Linter

`python3 scripts/docs_lint.py [docs-dir]` — stdlib only, read-only, exit code 1 on errors. Checks frontmatter schema and enums, ADR numbering and supersede symmetry, broken relative links, orphans, drafts older than 60 days, backlog size limits, and the `project.md` of the item layout. In the item layout the full item schema (ids, priorities, sections, `blocked_by`) is `rdk check --root docs/backlog` when the project has the portal's CLI. `--index` prints a generated index to stdout. Run it before declaring a docs change done and in the monthly routine.

## 9. Output naming

Docs this skill generates use kebab-case, lowercase, no accents: `0004-use-nats.md`, `2026-10-20-agent-verification.md`, `inbox.md`. The skill's own support files stay `UPPER_SNAKE_CASE`.

## 10. Out of scope

- **`CONTEXT.md` glossary and when to offer an ADR** → [grill-with-docs](../grill-with-docs/SKILL.md)
- **Requirement → design → slices** → [feature-planner](../feature-planner/SKILL.md)
- **Commit messages and `CHANGELOG.md` wording** → [commit-author](../commit-author/SKILL.md)
- **Root `README.md` / `CHANGELOG.md` authoring** — the user-facing entry points are not generated here; `changes/` entries may link a changelog line.

Files in this skill

  • BACKLOG.md9.1 KB
  • DIGEST.md2.3 KB
  • FRONTMATTER.md2.9 KB
  • MIGRATION.md4.2 KB
  • SKILL.md6.9 KB
  • TEMPLATES.md4.1 KB
  • scripts/docs_lint.py14.2 KB

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

View all in development →

Comments

Loading comments…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.