docs

Solid

Authors, audits, and maintains project documentation across CLAUDE.md / .claude/rules/, AGENTS.md, README.md, and Diátaxis docs/ trees (root + nested for monorepos). Four modes: init scaffolds a tiered docs setup from scratch; update detects drift (dead @imports, renamed commands, stale narrative) and incrementally refreshes via a Placement Resolver that pushes rules to the innermost-ancestor destination; readme writes or audits a README against the standard-readme spec; audit produces a documentation health report across every surface. Routes by kind: hard rules to CLAUDE.md, path-scoped patterns to .claude/rules/, narrative to docs/, marketing to README.md. Triggers on "init claude", "bootstrap docs", "scaffold CLAUDE.md", "update docs", "sync CLAUDE.md", "docs drift", "write a README", "audit our docs", "review the README", "Diátaxis", "/docs".

Data & Documents 8 stars 2 forks Updated 2 days ago MIT

Install

View on GitHub

Quality Score: 84/100

Stars 20%
32
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Documentation Author, audit, and maintain project documentation across every surface that matters: the **agent hot path** (`CLAUDE.md`, `AGENTS.md`, `.claude/rules/`), the **human entry point** (`README.md`), and the **narrative tier** (`docs/`). This is the single home for "make our docs good" work — bootstrapping a new project, refreshing docs after a sprint, writing a README that converts readers into users, or auditing the whole estate for drift. > **This `SKILL.md` is a thin index.** Detailed authoring rules live in > `rules/*.md` and load on demand. Worked examples are in > `references/*.md`. Literal scaffolding skeletons are in `templates/*.md`. > Do not preload everything — load only what the current phase asks for. --- ## Mode Detection Parse `$ARGUMENTS` (first token) and route to one of four modes. A second token of `--auto` is a cross-cutting modifier (see below). | Mode | Default | Trigger | | --------- | ------- | -------------------------------------------------------------------------------------- | | `init` | | "init", "bootstrap", "scaffold", or `$ARGUMENTS == "init"` (no existing CLAUDE.md). | | `update` | **yes** | Default when a `CLAUDE.md` already exists. "update", "sync", "refresh", "drift". | | `readme` | | "readme", "write a README", "audit the README", or `$ARGUMENTS == "readme"`. | | `audit` | | "audit", "revie...

Details

Author
mthines
Repository
mthines/agent-skills
Created
3 months ago
Last Updated
2 days ago
Language
TypeScript
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

docs

Routes one document to its Diataxis mode (tutorial, how-to guide, reference, explanation), drafts or edits it under that mode's constraints, and checks its markdown form against CommonMark 0.31.2. Use when: writing or generating documentation, deciding where a doc belongs, moving or reorganizing docs, splitting a document serving two audiences, reviewing docs for mode contamination, checking markdown form. Trigger phrases: what kind of doc is this, where does this doc belong, split this document, review this doc's placement, check this markdown, is this a tutorial or a how-to guide. Not for: ADRs and decision records, commit messages, changelogs and release notes, READMEs, code comments and docstrings, CLAUDE.md and agent or tool config. Checks mode, placement, and markdown form only, never factual accuracy.

4 Updated 2 weeks ago
backchainai
Code & Development Listed

docs-keeper

Maintains the four living documents of a hi-vibe project: CLAUDE.md (lean project context — constraints, pitfalls, rationale), per-folder MODULE.md (detailed design), handover.md (session-to-session context log), CHANGELOG.md (substantive change history, Keep a Changelog). Use for /hi-vibe:init, :handover, :log, :recall, :welcome, and whenever the user asks to 문서 정리, 인수인계 기록, 체인지���그 작성, CLAUDE.md 갱신, "이 폴더 문서 만들어줘", or after a structural change that must be reflected in docs. Also use (mode: recall) when the user asks about PAST decisions or work — "예전에 왜 이렇게 했지?", "저번에 뭐까지 했더라", "이거 언제 바꿨지", "왜 이 방식으로 결정했었지", why did we choose X — search the handover/archive/ CHANGELOG records instead of guessing from memory.

3 Updated 4 days ago
jx-hxxx
AI & Automation Listed

doc-audit

Documentation drift auditor and normalizer for CLAUDE.md / AGENTS.md projects (supports Claude Code, Codex, and any project using agent instruction files at root and/or per module). Use when the user says "audit docs", "check doc freshness", "doc drift", "docs out of date", "文档审计", "文档漂移", "检查文档", "文档同步", "memory index", "MEMORY.md check", "normalize docs", "整理文档", "更新文档", "update docs", "doc health", "文档健康". Also triggers implicitly when user mentions stale docs, wrong ports in CLAUDE.md / AGENTS.md, or missing memory entries.

3 Updated 4 days ago
Wubabalala