documentation-writing
Skill27 starsChanged 10 months agoNo licenceView on GitHub
Writing clear, discoverable software documentation following the Eight Rules and Diataxis framework. Use when creating README files, API docs, tutorials, how-to guides, or any project documentation. Automatically enforces docs/ location, linking requirements, and runnable examples.
We split this skill into the rules it gives an agent
12 rules. 0 are common, 10 are distinctive, and 2 are very specific to this project.
0
Common
Most of the 7 edited versions we read keep these.
10
Distinctive
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
No licence file, so all rights are reserved — read it at the source. We count its rules but don't quote them. Read them on GitHub.
“Common” is measured: kept by at least 6 in 10 of the 7 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.
Other versions9 projects use a version of this.
Word for word · 1
- tmcfarlane/team-avatar★ 111100% same
Edited · 1
- derheissenberg/applicaiton★ 278% same
Wrote their own version · 7
- ag2ai/faststream★ 5.4ksame name
- pavel-molyanov/molyanov-ai-dev★ 299same name
- 5throck/ai-workspace-standards★ 22same name
- AgentShekel/agentic-workflow★ 4same name
- stepanenkoviktor0110-boop/ai-dev-methodology★ 2same name
- z-Zihan/Evir★ 2same name
- redamoon/skills★ 1same name
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 code-writing, infrastructure-setup and 1 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.
stepanenkoviktor0110-boopSkillcode-writing
Universal quality coding process: plan, TDD, reviews. Use whenever code needs to be written — ad-hoc or as part of a task.
Also in 3 projects that use this
- stepanenkoviktor0110-boopSkill
infrastructure-setup
Sets up dev infrastructure for new projects: framework init, folder structure, Docker, pre-commit hooks (gitleaks), testing infrastructure, .gitignore.
Also in 3 projects that use this
- +1 more from stepanenkoviktor0110-boop
In this repository54 other files it gives its agents.
- Agent DevelopmentSkill
- api-design-principlesSkill
- applying-brand-guidelinesSkill
- architecture-diagramsSkill
- architecture-patternsSkill
- artifacts-builderSkill
- async-python-patternsSkill
- auth-implementation-patternsSkill
- backend-developmentSkill
- Brainstorming Ideas Into DesignsSkill
- canvas-designSkill
- claude-code-analyzerSkill
- code-refactorSkill
- convex-backendSkill
- Create database migrationSkill
- deepresearch-integratorSkill
- deployment-pipeline-designSkill
- DevOps EngineerSkill
- docstringSkill
- documentation-generationSkill
- drawio-diagrams-enhancedSkill
- frontend-designSkill
- frontend-testingSkill
- Hook DevelopmentSkill
- hybrid-search-implementationSkill
- llm-docs-optimizerSkill
- mermaidSkill
- microservices-patternsSkill
- nano-bananaSkill
- PDF Processing ProSkill
- postgresql-table-designSkill
- pptxSkill
- prompt-engineering-patternsSkill
- prompt-factorySkill
- rag-implementationSkill
- Remembering ConversationsSkill
- senior-architectSkill
- senior-data-engineerSkill
- senior-frontendSkill
- shadcnSkill
- shopifySkill
- skill-creatorSkill
- skill-developerSkill
- skill-installerSkill
- skill-writerSkill
- subagent-driven-developmentSkill
- technical-doc-creatorSkill
- ui-designerSkill
- using-shadcn-uiSkill
- ux-designerSkill
- web-artifacts-builderSkill
- worktreesSkill
- writing-clearly-and-conciselySkill
- writing-documentationSkill
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.