document
Skill2 starsChanged 46 days agoApache-2.0View on GitHub
Post-work documentation orchestrator for this repository. Given what was just done in the session, checks every documentation surface (guidelines, ADRs, git-workflow rules, site changelog, GitHub Projects, npm/starter-kit READMEs, component stories), writes the relevant ones, verifies the build/tests, and proposes — never executes — a commit and push. Invoke as `/document`, optionally followed by a short description of what to document.
- Commits and pushes
56 other projects use a version of this.
Adopted by
Most recently taken up by
- blauwtje/exotheir own version, first seen Nov 16, 2026
- GoBeromsu/craft-skillstheir own version, first seen Nov 16, 2026
- mystilleef/spae-frameworktheir own version, first seen Nov 13, 2026
- elfrost/ai-patchlabtheir own version, first seen Nov 9, 2026
- daledesilva/obsidian_inktheir own version, first seen Nov 9, 2026
- domengabrovsek/agent-configtheir own version, first seen Nov 8, 2026
Used with
Projects with it also use develop, scope and 10 more.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
hong9LeeSkilldevelop
빌드, 아키텍처, git 관련 작업 시 OMS MSA 공통 인프라 규칙을 적용한다. 기술 스택, 빌드 명령, 헥사고날 아키텍처 구조, git 워크플로우, AI Context 동기화 규칙을 다룬다. 코드 작성 컨벤션은 /convention, 테스트 컨벤션은 /test-guide 스킬을 참조.
Also in 5 projects that use this
YuriNachosSkillscope
Configure claude-scope status line widgets for Claude Code. Use when user wants to customize widgets, change theme, reorder elements, or modify display style.
Also in 5 projects that use this
ralphkraussSkillresolve-conflicts
Resolve git merge conflicts or re-apply changes from a stale branch onto current main. Use when user says "resolve conflicts", "merge conflicts", "rebase branch", "branch is behind", "re-apply changes", "port branch", or a branch is too far behind main to merge cleanly.
Also in 3 projects that use this
MicrosoftSkillsync
Sync the current session branch with its upstream branch, or publish the current session branch to a remote. Use when the user asks to sync a branch, pull latest changes, rebase onto upstream, push current branch, publish branch, or set upstream.
Also in 5 projects that use this
kt057Skillcheck
lint, typecheck, test を一括実行して結果をサマリーする
Also in 7 projects that use this
Microsoft AzureSkilltest
Also in 12 projects that use this
Other versions56 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 56
- Akylas/OSS-DocumentScanner★ 2.7ksame name
- jsmastery-pro/skills★ 1.4ksame name
- daledesilva/obsidian_ink★ 1.4ksame name
- adobe/S3Mock★ 1.2ksame name
- ZimoLiao/scholaraio★ 589same name
- vladikk/modularity★ 538same name
- Akylas/oss-weather★ 485same name
- spiriMirror/libuipc★ 351same name
- jsmastery-pro/jsm-hq★ 102same name
- nitinjain999/platform-skills★ 71same name
46 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository16 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- ai-component-metadataSkill
- ai-ds-composerSkill
- codebase-indexSkill
- documentSkill
- post-change-pipelineSkill
- quality-gateSkill
- ux-pattern-reviewSkill
- ai-component-metadataSkill
- ai-ds-composerSkill
- codebase-indexSkill
- post-change-pipelineSkill
- quality-gateSkill
- ux-pattern-reviewSkill
- design-system-builderSkill
The file
We split this skill into the rules it gives an agent
7 rules. 0 are common, 4 are distinctive, and 3 are very specific to this project.
0
Common
Most of the 52 edited versions we read keep these.
4
Distinctive
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 63
Do not document something that didn't actually happen, and do not infer scope beyond what the diff and conversation actually support.
- Very specific: line 68
Read the full trigger matrix in .claude/skills/pipelines/docs.md — the canonical, single-source-of-truth list of every documentation …
- Very specific: line 89
Follow that surface's own established conventions (tone, structure, bilingual FR/EN spans on the site, Conventional Commits phrasing in …
- Distinctive: line 92
Prefer updating an existing entry (a ticket, a changelog section) over creating a duplicate when the work is a continuation of something …
- Distinctive: line 94
Keep entries factual and specific (file paths, PR/ADR numbers, concrete outcomes) over vague summaries — matches this repository's existing …
- Distinctive: line 99
Run whatever subset of these actually applies to what was touched in Step 3:
- Very specific: line 124
If branch protection currently forbids direct pushes to the target branch (enforce_admins: true, see ADR-077), the proposed action is a …
“Common” is measured: kept by at least 6 in 10 of the 52 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Skill: document
Post-work documentation orchestrator, invoked as
/document. Given what was just done in the session, checks every documentation surface the repository has, writes the relevant ones, verifies nothing broke, and proposes (never executes) a commit and push. Type: skill Logical path: .claude/skills/document/SKILL.md Read before: AGENTS.md, governance/rules/post-change-pipeline.md Relations: .claude/skills/pipelines/docs.md, .claude/skills/quality-gate/SKILL.md, governance/rules/git-workflow.md
Absolute rule
No commit or push happens automatically.
/documentalways ends in a proposal, never in an executed commit. Same governance boundary asquality-gate.mdandgit-workflow.md— the human always has the final word.
Relationship to quality-gate.md
quality-gate.md is the full pre-commit gate: token consistency, WCAG, UX pattern
review, ADR compliance, missing-ADR triggers, documentation, site rebuild, commit —
run for every change, however small. /document is narrower and lighter: it only
walks the documentation surfaces (via pipelines/docs.md) and verifies the build/tests
don't break. Reach for /document after a chunk of work is functionally done and
already committed-worthy, specifically to catch up documentation surfaces that are
easy to forget because they live outside the file(s) actually changed — GitHub
Projects and the site changelog above all, per this skill's own origin (created after
those two were repeatedly updated by hand, ad hoc, across several sessions). It does
not replace quality-gate.md for changes that also touch tokens, components, or
site pages directly — run both when in doubt.
Trigger
The user types /document, optionally followed by a short description of what to
document (e.g. /document the npm publication chantier). With no argument, the scope
is "everything done in this session that isn't reflected in documentation yet" —
reconstructed from conversation context and git log/git diff against the last
pushed commit on the current branch.
Process
Step 1 — Establish what was actually done
Build a factual list of the session's changes before touching any documentation:
git log --onelinesince the branch diverged frommain(or since the last push)git diff --statfor anything still uncommitted- Conversation context for intent/rationale a diff alone won't show (why a decision was made, what was explicitly rejected, what the user asked for)
Do not document something that didn't actually happen, and do not infer scope beyond what the diff and conversation actually support.
Step 2 — Check every place against pipelines/docs.md
Read the full trigger matrix in .claude/skills/pipelines/docs.md — the canonical,
single-source-of-truth list of every documentation surface in this repository. For
each row, decide relevant/not relevant against Step 1's list, and say so explicitly
(a place that's genuinely not applicable is reported as "N/A", never silently skipped).
Two surfaces are the most commonly missed because they live outside the changed files entirely — always check them explicitly, even for small changes:
- GitHub Projects (Backlog/board) — was a chantier completed, started, or newly identified?
- Site changelog (
buildChangelog()insite/build.js) — was anything user-visible shipped (feature, fix, decision)?
Also check .claude/skills/pipelines/adr-triggers.md explicitly — governance changes
(new CI/CD pipeline, new governance rule) require a new ADR even when no token,
component, or site file changed. An ADR that reverses or amends a still-Active ADR
is a new ADR referencing the one it amends — ADRs are immutable once active, never
edited in place (see decisions/README.md's registry rules).
Step 3 — Document
For each relevant surface identified in Step 2:
- Follow that surface's own established conventions (tone, structure, bilingual FR/EN spans on the site, Conventional Commits phrasing in changelogs, the Status/Domaine/Date/ADR fields on GitHub Projects per ADR-069)
- Prefer updating an existing entry (a ticket, a changelog section) over creating a duplicate when the work is a continuation of something already tracked
- Keep entries factual and specific (file paths, PR/ADR numbers, concrete outcomes) over vague summaries — matches this repository's existing documentation style
Step 4 — Verify nothing is broken
Run whatever subset of these actually applies to what was touched in Step 3:
node site/build.js— required if any site page or the changelog changed; confirm 0 orphaned CSS variables and no build errornpm run lang-audit— required if any bilingual site content was added or a non-site file with English-only requirements was touched. Run it aftergit addon any new file, not before: the script scansgit ls-files(tracked files only), so a new untracked file passes a pre-add local run clean and only fails once CI sees it as tracked — this exact gap shipped a real failure once, from a French GitHub Projects status value quoted verbatim in this skill's own report-format example below, added to a new file and never re-scanned locally after staging- Structural HTML validation on any page whose template changed (balanced tags,
no orphaned wrapper divs — see the
get-started.htmltable-wrap incident for why this matters even when the build script reports success) - Bilingual FR/EN parity check (
lang-fr/lang-enspan counts) on any site page edited - A GitHub Projects item, once created or edited, is read back
(
gh project item-list/item-view) to confirm the field values actually saved — the API has silently rejected malformed field updates before
Step 5 — Report and propose
Present a report in the format below, then stop and wait for explicit approval
before staging, committing, or pushing anything — exactly like quality-gate.md.
If branch protection currently forbids direct pushes to the target branch
(enforce_admins: true, see ADR-077), the proposed action is a feature//docs/
branch + PR + merge, not a direct push — say so explicitly in the proposal rather
than defaulting to git push.
Report format
## /document — report
### What this covers
[1-2 sentences: the chunk of work being documented, with commit range or PR references]
### Documentation surfaces checked
- [x] Site changelog — added 3 bullets under "npm publication" (Unreleased)
- [x] GitHub Projects — ticket #NNN created/updated, status → Terminé <!-- lang-audit-ignore: literal GitHub Projects Status field value, which is French in this project -->
- [ ] guidelines/components/*.md — N/A, no component behavior changed
- [ ] decisions/ADR-0XX.md — N/A, no new architectural decision
- [x] packages/tokens/README.md — N/A, already up to date
- ...(every row of pipelines/docs.md gets a line, including the N/A ones)
### Verification
- [x] node site/build.js — 109 files generated, 0 orphaned CSS variable
- [x] Bilingual parity — 132/132
- [x] GitHub Projects fields confirmed via item-list read-back
### Proposed commit
[branch name, commit message following git-workflow.md conventions]
Proceed with commit and push?What this skill does NOT do
❌ Commit or push without explicit approval — reports and proposes only
❌ Invent facts, PR numbers, or outcomes not actually verifiable from the diff/conversation
❌ Skip a row in pipelines/docs.md without stating why it's N/A
❌ Create a duplicate GitHub Projects ticket for work already tracked elsewhere
❌ Run the full quality-gate.md pipelines (tokens/WCAG/UX/ADR compliance) — use
quality-gate.md directly when those are actually in scopeDoes it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

