Skip to content
Skills Library
Documents & office · Building & coding

cmk:docs

/cmk:docs

Use when the user asks to "set up docs", "initialize docs", "docs scaffold", "check if our docs structure is current", "update the docs structure", "check docs connectedness", or needs to bootstrap, update, or verify the /docs directory structure with navigation READMEs and document templates.

Repository
ai-devkit ↗
Licence
MIT
Last repository change
20.10.2026

Assessment and security

80/ 100Class: good
Format15 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content25 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
2
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 20.10.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

Use when the user asks to "set up docs", "initialize docs", "docs scaffold", "check if our docs structure is current", "update the docs structure", "check docs connectedness", or needs to bootstrap, update, or verify the /docs directory structure with navigation READMEs and document templates.

Triggers from the description

set up docsinitialize docsdocs scaffoldcheck if our docs structure is currentupdate the docs structurecheck docs connectedness
Original author description

Use when the user asks to "set up docs", "initialize docs", "docs scaffold", "check if our docs structure is current", "update the docs structure", "check docs connectedness", or needs to bootstrap, update, or verify the /docs directory structure with navigation READMEs and document templates.

How it works

  1. Progressive disclosure
  2. References
  3. Modes
  4. Workflow
  5. Output
Original SKILL.md headings · 43 lines, 419 words
SKILL.md preview
---
name: cmk:docs
description: Use when the user asks to "set up docs", "initialize docs", "docs scaffold", "check if our docs structure is current", "update the docs structure", "check docs connectedness", or needs to bootstrap, update, or verify the /docs directory structure with navigation READMEs and document templates.
version: 0.3.1
---

# Docs

Bootstrap or update the `/docs` directory structure with navigation READMEs and document templates. Supports first-time scaffolding, re-syncing after devkit changes, and dry-run verification.

## Progressive disclosure

The docs tree is organized for progressive disclosure: every folder's README is a concise navigation index — one line per child saying what it is and when to read it — and depth lives one level down. A reader starts at `docs/README.md`, follows the index to the area that matters, and dives deeper only as needed; no doc assumes the reader loaded the whole tree. Keep each document small and self-contained enough to be referenced as a unit by other docs — composable pieces, not monoliths — and cross-reference related docs (requirements ↔ design ↔ decisions ↔ glossary) so the tree stays coherent rather than merely adjacent.

Coherence is bidirectional: updating a doc means checking its inbound references (who links here, who builds on this claim) and cascading or flagging them in the same change. The Verify mode's connectedness check is the mechanical floor for this — orphans and dangling links are coherence failures made visible.

## References

Read `references/scaffold-manifest.md` for the complete file manifest and exact content for each file.

## Modes

**Init** (default) — First-time scaffolding. Create missing directories, READMEs, and templates. Never overwrite existing files. Report divergences.

**Update** — Re-sync after devkit changes. Create newly added files, compare each `README.md` against the manifest and report divergences, add new templates without overwriting customized ones. Confirm with user before modifying existing files.

**Verify** — Dry-run. Report gaps and divergences without creating or modifying anything. Connectedness check: report canonical docs (in `decisions/`, `requirements/`, `design/`) with no inbound links from any other doc (orphans), and links pointing at missing files (dangling).

## Workflow

1. Determine mode from user intent.
2. Scan target repository for existing `/docs` structure.
3. Compare against `references/scaffold-manifest.md`.
4. Execute based on mode (init → create missing; update → create missing + offer fixes; verify → report only).
5. Create directories before contents, in order: `docs/`, `templates/`, `decisions/`, `requirements/`, `design/`, `rules/`, `rules/common/`, `guides/`, `runbooks/`, `reports/`, `research/`, `knowledge/`, `ai/`.
6. For each directory, create `README.md`.
7. Report: created, skipped, diverged, updated.

## Output

- Every directory has exactly one `README.md`
- `docs/README.md` → per-directory README chain is intact
- Each README is a concise navigation index over its children, not a content dump
- Templates directory contains all baseline templates
- Init mode never modifies existing files
- Update mode confirms before modifying
- Verify mode makes no file changes
Files in this package (2)
  • SKILL.md 3 KB
  • references/scaffold-manifest.md 19 KB

Versions

The database has no other skills named cmk:docs.

Database snapshot: 13.11.2026 · package version 7c05aabb4e3d (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 85cmk:codebase-docs
    Use when the user asks to "document the codebase for AI", "bootstrap AI docs", "generate codebase map", "set up AI navigation docs", "update AI docs", "refresh docs after change", or mentions building progressive-disclosure docs so an AI can find the right source files quickly.…
  • 90cmk:delivery-spec-plan
    Use when the user asks for a "spec", "implementation plan", or tracker-issue design scratch after intake — phase 2 of `cmk:delivery-pipeline`. Produces git-ignored scratch spec + plan with task dependency structure. Durable `docs/design/` docs → `cmk:design`.
  • 95docs-manager
    Documentation management workflow for MkDocs sites and standalone markdown files — initialize, generate, update docs, and create change summaries. Use when asked to "create docs", "write README", "update documentation", "generate docs site", "write CONTRIBUTING", "manage…
  • 100update-docs
    Update READMEs, changelogs, API docs, runbooks, and instruction files after changes; fix doc drift. Use for "update the docs" or a release sweep.
  • 100docs-init
    Bootstraps a documentation structure (architecture, onboarding, data-model, deployment, security, contributing, and a first ADR) for a project that has little or no docs/ directory, exploring the codebase and populating templates only with content evidenced in the code. Use when…
  • 100docs-writer
    Always use this skill when the task involves writing, reviewing, or editing files in the `/docs` directory or any `.md` files in the repository.

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.