writing-documentation
Skill0 starsChanged 6 months agoNo licenceView on GitHub
Write clear, skimmable technical documentation — READMEs, runbooks, ADRs, API references, troubleshooting guides, specs, design docs. Enforces three principles: easy to skim, well-written, broadly helpful. Use when creating or revising any docs over ~30 lines, when reviewing docs before publishing, when a doc feels hard to read, or when the user asks to "write a README / runbook / guide / API reference", "review these docs", or "improve this documentation".
12 other projects use a version of this.
Adopted by
Most recently taken up by
- pvliesdonk/markdown-vault-mcptheir own version, first seen Nov 2, 2026
- gerardbalaoro/skillstheir own version, first seen Nov 1, 2026
- pvliesdonk/paperless-mcptheir own version, first seen Nov 1, 2026
- pvliesdonk/scholar-mcptheir own version, first seen Nov 1, 2026
- alexisbeaulieu97/agent-skillstheir own version, first seen Nov 1, 2026
- rapidaai/voice-aitheir own version, first seen Oct 8, 2026
Used with
Projects with it also use applying-template-updates, authoring-issues-prs 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.
pvliesdonkSkillapplying-template-updates
Use when asked to work through, apply, resolve or review a template update pull request (the weekly `copier/update` branch opened by the copier-update workflow), after running `copier update --trust` by hand, or when a template update looks like it leaves no room for something this project needs.
Also in 3 projects that use this
- pvliesdonkSkill
authoring-issues-prs
Use when filing a bug, opening or creating a GitHub issue, drafting an epic or ticket, writing up a finding or review observation worth tracking, sizing a change before coding, or opening a pull request for this repository. Routes the change to the right repo first (library / template / domain), picks the right issue form, sizes the change to one PR, links epic children as native sub-issues, and applies CONTRIBUTING.md before anything is posted.
Also in 3 projects that use this
zpower426Skillroadmapping
Communicate the product evolution timeline and key milestones, balancing long-term goals with short-term delivery.
Also in 3 projects that use this
quocldSkilllogging-standard
Use when writing or reviewing code that logs, when creating or changing a logger, request or job correlation, or log redaction, and when the user says "setup log", "setup logger", "thêm log", "chuẩn hoá log", "log bị lộ token", "log quá nhiều", "review log".
Also in 3 projects that use this
MicrosoftSkillwriting-release-notes
Generates release notes and changelog entries for the DocumentDB extension for Visual Studio Code, and announces releases on GitHub Discussions. Use when preparing version releases, creating patch update notes, writing changelog entries, documenting new features and fixes, or posting a release or patch release announcement to Discussions. Handles both major/minor versions (new file) and patch updates (append to existing file).
Also in 3 projects that use this
- +7 more from pvliesdonk
Other versions12 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 12
- TriliumNext/Trilium★ 39ksame name
- rapidaai/voice-ai★ 755same name
- PrefectHQ/fastmcp-ts★ 82same name
- pvliesdonk/markdown-vault-mcp★ 38same name
- nilecui/SkillsBase★ 27same name
- pvliesdonk/scholar-mcp★ 3same name
- theperrygroup/Follow-Up-Boss-MCP★ 2same name
- alexisbeaulieu97/agent-skills★ 1same name
- ccgargantua/gars-claude-skills★ 1same name
- pvliesdonk/paperless-mcp★ 1same name
2 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 repository3 other files it gives its agents.
- building-modal-appsSkill
- interactive-explainersSkill
- naming-thingsSkill
The file
We split this skill into the rules it gives an agent
2 rules. 0 are common, 2 are distinctive, and 0 are very specific to this project.
0
Common
Most of the 11 edited versions we read keep these.
2
Distinctive
This author's own choices. Worth a look.
0
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 11 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.
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.