document
Skill459 starsChanged 3 months agoMITView on GitHub
best practices to write good documentation
We split this skill into the rules it gives an agent
1 rule. 0 are common, 1 is distinctive, and 0 are very specific to this project.
0
Common
Most of the 44 edited versions we read keep these.
1
Distinctive
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 6
Follow this guide to write proper documentation every time write-documentation.md
“Common” is measured: kept by at least 6 in 10 of the 44 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
Follow this guide to write proper documentation every time write-documentation.md
Other versions49 projects use a version of this.
Word for word · 1
- Akylas/OSS-DocumentScanner★ 2.6k100% same
Edited · 0
None found.
Wrote their own version · 48
- jsmastery-pro/skills★ 1.4ksame name
- adobe/S3Mock★ 1.2ksame name
- ZimoLiao/scholaraio★ 577same name
- vladikk/modularity★ 538same name
- spiriMirror/libuipc★ 336same name
- nitinjain999/platform-skills★ 71same name
- epicsagas/epic-harness★ 22same name
- domengabrovsek/agent-config★ 20same name
- domengabrovsek/claude★ 20same name
- ilanbm/kpopper★ 12same name
38 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.
Used alongsideProjects with it also use develop, resolve-conflicts 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
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
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
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 9 projects that use this
In this repository11 other files it gives its agents.
- .claude/CLAUDE.mdCLAUDE.md
- branch-checkSkill
- commitSkill
- writing-great-skillsSkill
- featSkill
- fixSkill
- grill-meSkill
- investigate-contractSkill
- open-prSkill
- save-plan-to-githubSkill
- understand-projectSkill
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
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.

