project-docs
Skill0 starsChanged 30 days agoNo licenceView on GitHub
Write a complete, opinionated project plan and documentation set from a project description — PROJECT.md, CLAUDE.md, README.md and a numbered docs/ spine (product, domain core, architecture, data, engineering practices, roadmap, stack, provider setup), diagrams in Mermaid, on a fixed baseline per profile: web (TypeScript monorepo with pnpm, Turborepo, Biome, Zod, Drizzle, Postgres, Elysia or Hono), macos (Swift, SwiftUI with AppKit, XcodeGen, lefthook) or cli (TypeScript, commander, tsdown, npm). Includes the GitHub setup (ruleset on main, hosted unit, integration and end-to-end checks) and the delivery loop of worktree, pre-push gate, pull request and squash merge. Use when starting a new project, planning a web app, a Mac app or a CLI, planning a rewrite, writing a spec or technical plan, bootstrapping a repository, producing docs/ for an existing codebase, or when asked to "document this project", "plan this project", "write the docs", "montar a documentação", "criar o plano do projeto".
- Reads credentials
- Commits and pushes
22 other projects use a version of this.
Adopted by
Most recently taken up by
- ainiaa/skills-project-docstheir own version, first seen Nov 8, 2026
- snowfluke/tech-lead-skillstheir own version, first seen Nov 8, 2026
- MasihMoafi/skillstheir own version, first seen Nov 1, 2026
- coco-research/cocotheir own version, first seen Nov 1, 2026
- byrodi/project-docstheir own version, first seen Nov 1, 2026
- GambiarraFinance/gambiarra-v2their own version, first seen Oct 20, 2026
Used with
Projects with it also use test-audit, to-issues and 3 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.
BlockSkilltest-audit
Invoke whenever writing, changing, reviewing, or sweeping tests in buzz-app. Authoring gate for new tests plus audit workflow for low-value, implementation-coupled, or duplicative tests and the test-only production seams they demand.
Also in 3 projects that use this
GoogleSkillto-issues
Break a plan, spec, or PRD into independently-grabbable issues on the project issue tracker using tracer-bullet vertical slices.
Also in 3 projects that use this
- GoogleSkill
to-prd
Turn the current conversation into a PRD and publish it to the project issue tracker — no interview, just synthesis of what you've already discussed.
Also in 3 projects that use this
Google CloudSkilltriage
Gather context on a change or bug and plan the implementation.
Also in 3 projects that use this
- BlockSkill
frontend-design
Create distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, or applications. Generates creative, polished code that avoids generic AI aesthetics.
Also in 3 projects that use this
Other versions22 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 22
- xstongxue/best-skills★ 2.9ksame name
- coco-research/coco★ 797same name
- waynesutton/convexskills★ 405same name
- waynesutton/builder-skills★ 404same name
- vstorm-co/agenticos★ 241same name
- s-hiraoku/synapse-a2a★ 17same name
- cablate/ai-toolkit★ 15same name
- MasihMoafi/skills★ 8same name
- snowfluke/my-tech-lead-flow★ 8same name
- snowfluke/tech-lead-skills★ 8same name
12 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 repository10 other files it gives its agents.
- skills/project-docs/templates/CLAUDE.mdCLAUDE.md
- git-commitSkill
- git-pr-fixSkill
- git-prSkill
- git-rename-branchSkill
- git-stackSkill
- git-worktree-describeSkill
- git-worktree-setupSkill
- git-worktreeSkill
- reportSkill
The file
Show its rules and text
We split this skill into the rules it gives an agent
15 rules. 0 are common, 3 are distinctive, and 12 are very specific to this project.
0
Common
Most of the 18 edited versions we read keep these.
3
Distinctive
This author's own choices. Worth a look.
12
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 18 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.