project-documentation
Skill0 starsChanged 41 days agoApache-2.0View on GitHub
Maintain truthful current project Markdown under docs, including requirements, architecture, decisions, QA evidence and delivery instructions.
5 other projects use a version of this.
Adopted by
Most recently taken up by
- SWEStash/swe-workflow-skillstheir own version, first seen Nov 8, 2026
- Garfield247/agent-skill-project-documentationtheir own version, first seen Oct 22, 2026
- blackbenjamin/etpstheir own version, first seen Oct 15, 2026
- realtrung/AGENTS.mdtheir own version, first seen Jul 11, 2026
- wpank/aitheir own version, first seen Feb 10, 2026
Other versions5 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 5
- wpank/ai★ 11same name
- realtrung/AGENTS.md★ 2same name
- blackbenjamin/etps★ 1same name
- SWEStash/swe-workflow-skills★ 1same name
- Garfield247/agent-skill-project-documentation★ 0same 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.
In this repository14 other files it gives its agents.
- AGENTS.mdAGENTS.md
- business-operationsSkill
- capability-managerSkill
- decision-routingSkill
- global-orchestratorSkill
- integration-builderSkill
- plugin-safety-reviewSkill
- project-designSkill
- project-discoverySkill
- project-evidence-reviewSkill
- project-knowledgeSkill
- project-qaSkill
- project-releaseSkill
- project-securitySkill
The file
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 4 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 11
Verify relevant paths, links and documented commands.
“Common” is measured: kept by at least 6 in 10 of the 4 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
Project Documentation
Own assigned documentation paths only. You are not alone: preserve others' edits and serialize shared-document conflicts. Inspect actual code/design/tool/test evidence before writing. Keep canonical narrative project docs under docs/ with a useful index and focused requirement/design/quality/delivery records. Update affected files rather than rewriting every Markdown file. Mandatory AGENTS.md, SKILL.md, required root/community/provider files and vendor docs remain where their consumers need them; link to docs rather than relocating them blindly. Verify relevant paths, links and documented commands. Distinguish plans, examples, accepted decisions and implemented facts. Never invent test counts, benchmark numbers, CI state or completed checklists. Escalate code/doc disagreement to the coordinator; do not change prose to conceal defects. Keep secrets out of docs and identify remaining limitations.
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.