document
Skill1 starsChanged 30 days agoMITView on GitHub
Auto-generate or update project documentation from code — API reference, data dictionary, architecture overview, module docs. Mechanical extraction; never overwrites manual content marked with `<!-- manual -->`.
54 other projects use a version of this.
Adopted by
Most recently taken up by
- daledesilva/obsidian_inktheir own version, first seen Nov 9, 2026
- domengabrovsek/agent-configtheir own version, first seen Nov 8, 2026
- domengabrovsek/claudetheir own version, first seen Nov 8, 2026
- dimsedra/skillstheir own version, first seen Nov 8, 2026
- codewhale-hq/codewhale-plugin-marketplacetheir own version, first seen Nov 8, 2026
- jisuzzzz/haechitheir own version, first seen Nov 8, 2026
Used with
Projects with it also use develop, scope and 9 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 versions54 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 54
- Akylas/OSS-DocumentScanner★ 2.6ksame name
- jsmastery-pro/skills★ 1.4ksame name
- daledesilva/obsidian_ink★ 1.4ksame name
- adobe/S3Mock★ 1.2ksame name
- ZimoLiao/scholaraio★ 585same name
- vladikk/modularity★ 538same name
- Akylas/oss-weather★ 478same name
- spiriMirror/libuipc★ 351same name
- nitinjain999/platform-skills★ 71same name
- jsmastery-pro/jsm-hq★ 47same name
44 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 repository25 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- audit-projectSkill
- cleanupSkill
- create-skillSkill
- dailySkill
- dependency-checkSkill
- execute-prpSkill
- ez-project-workflowSkill
- fix-issueSkill
- generate-prpSkill
- housekeepingSkill
- kickoffSkill
- monitor-setupSkill
- nextSkill
- performanceSkill
- pipelineSkill
- refactorSkill
- retrospectiveSkill
- review-codeSkill
- rollbackSkill
- security-scanSkill
- statusSkill
- tddSkill
- upgrade-statusSkill
The file
We split this skill into the rules it gives an agent
12 rules. 0 are common, 6 are distinctive, and 6 are very specific to this project.
0
Common
Most of the 50 edited versions we read keep these.
6
Distinctive
This author's own choices. Worth a look.
6
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 9
Read CLAUDE.md for stack type
- Very specific: line 11
Read docs/schema.sql if it exists (data dictionary source)
- Very specific: line 12
Read existing docs/ files — preserve sections marked <!-- manual -->
- Very specific: line 13
Read DECISIONS.md for ADRs (architecture overview source)
- Very specific: line 14
Read examples/ for pattern descriptions
- Very specific: line 23
Default scope: all ($ARGUMENTS can narrow to api, data, architecture, or modules).
- Distinctive: line 31
Verify all referenced files / classes / functions exist
- Very specific: line 39
NEVER overwrite sections marked <!-- manual -->
- Distinctive: line 40
ALWAYS verify generated references point to real code
- Distinctive: line 41
If a public function has no docstring, generate one and add it to the source
- Distinctive: line 43
Use Google-style docstrings to match the project convention
- Distinctive: line 44
Keep generated docs concise (tables over paragraphs)
“Common” is measured: kept by at least 6 in 10 of the 50 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
Document
Phase 1: Discover
- Read CLAUDE.md for stack type
- Scan
src/for modules, classes, functions - Read
docs/schema.sqlif it exists (data dictionary source) - Read existing
docs/files — preserve sections marked<!-- manual --> - Read
DECISIONS.mdfor ADRs (architecture overview source) - Read
examples/for pattern descriptions
Phase 2: Extract
- Code: docstrings (Google-style), type hints, function signatures
- Schema: CREATE TABLE statements, columns, indexes, comments
- ADRs: title + decision + status from
DECISIONS.md - ROADMAP: current phase + completed features
Phase 3: Generate
Default scope: all ($ARGUMENTS can narrow to api, data, architecture, or modules).
- API reference (api / ai-agent stacks): list endpoints with method, path, parameters, response model. Output:
docs/api-reference.md - Data dictionary (MySQL in stack): tables, columns, types, constraints, FKs, indexes. Output:
docs/data-dictionary.md - Architecture overview: module dependency graph, key patterns, active ADRs. Output:
docs/architecture.md - Module docs: per module — purpose, public API, usage examples. Output:
docs/modules.md
Phase 4: Quality check
- Verify all referenced files / classes / functions exist
- Flag stale references (deleted code)
- Flag undocumented public functions (missing docstrings)
Phase 5: Report + commit
Show the user a coverage summary (documented vs undocumented public APIs). Ask before writing. Commit separately: docs: auto-generate documentation.
Rules
- NEVER overwrite sections marked
<!-- manual --> - ALWAYS verify generated references point to real code
- If a public function has no docstring, generate one and add it to the source
- Show diffs before writing
- Use Google-style docstrings to match the project convention
- Keep generated docs concise (tables over paragraphs)
- Include the generation date for staleness tracking
Does 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.