project-layout
Skill1 starsChanged 5 months agoUnlicenseView on GitHub
Define and enforce the standard project paths for documentation, plans, notes, references, research, and publications. Use when creating or organizing a project or when another skill creates durable project artifacts.
2 other projects use a version of this.
Adopted by
Most recently taken up by
- rafapeixer/java-skillstheir own version, first seen Oct 20, 2026
- huguryildiz/ALETHEIAtheir own version, first seen Jul 6, 2026
Other versions2 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 2
- rafapeixer/java-skills★ 1same name
- huguryildiz/ALETHEIA★ 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 repository13 other files it gives its agents.
- architectural-reviewSkill
- auto-research-repoSkill
- clumsy-ms-paint-redrawSkill
- godot-gdscript-patternsSkill
- grill-meSkill
- grill-with-docsSkill
- local-wikipedia-searchSkill
- next-stepSkill
- pygame-patternsSkill
- python-refactorSkill
- simplifySkill
- system-verilog-expertSkill
- wiki-meSkill
The file
We split this skill into the rules it gives an agent
6 rules. About 0 are common, 3 are distinctive, and 3 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈3
Distinctive · estimate
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 8
Treat all paths as relative to the project root, normally the Git worktree root.
- Very specific: line 22
Keep tool-required files such as README.md, AGENTS.md, CLAUDE.md, LICENSE, and ecosystem configuration at the root.
- Distinctive: line 26
When a skill creates a durable project artifact, place it under these paths.
- Very specific: line 48
Keep non-status notes in plans/notes/.
- Distinctive: line 49
Update links when moving a plan.
- Very specific: line 53
Create every canonical directory in greenfield and early-stage projects.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Project Layout
Treat all paths as relative to the project root, normally the Git worktree root. Use this layout for new work; do not introduce alternative paths.
| Path | Purpose |
docs/ | Maintained project documentation and knowledge. |
docs/wiki/ | Interlinked or LLM-maintained knowledge base. |
docs/public/ | Portable publication output. |
plans/to-do/ | Draft or queued work. |
plans/in-progress/ | Active work that must survive across sessions. |
plans/completed/ | Finished plans retained as history. |
plans/notes/ | Exploratory notes, notebooks, and long-term guidance. |
ref/ | Immutable external sources and reference inputs. |
ref/inbox/ | The one mutable lane under ref/: staging for sources awaiting placement. Files become immutable once moved into ref/. |
Keep tool-required files such as README.md, AGENTS.md, CLAUDE.md, LICENSE, and ecosystem configuration at the root.
Source paths such as src/, tests/, package assets, repository utilities, and files inside an installed skill follow their own ecosystem conventions.
When a skill creates a durable project artifact, place it under these paths.
Legacy Equivalents
Use the canonical paths for new work. On an existing project, recognize these legacy names and keep using one established tree rather than creating a parallel canonical one. Migrate only when the user asks or the task includes reorganization; never split one artifact class across canonical and legacy paths.
| Legacy path | Canonical destination |
doc/ | docs/ |
wiki/ | docs/wiki/ |
corpus/ | docs/public/ |
plan/ | plans/ |
todos/, tasks/, plans/todos/ | plans/to-do/ |
notebook/, scratchpad/, thoughts/, notes/ | plans/notes/ |
raw/, reference/ | ref/ |
ingest/ | ref/inbox/ |
Plan Lifecycle
- Draft work in
plans/to-do/<slug>.md. - Move it to
plans/in-progress/<slug>.mdwhen work starts. - Move it to
plans/completed/YYYY-MM-DD-<slug>.mdwhen complete. - Keep non-status notes in
plans/notes/. - Update links when moving a plan; do not leave duplicate copies.
Structure Markers
Create every canonical directory in greenfield and early-stage projects. Place and retain .gitkeep in each directory so the intended structure remains explicit and survives temporary emptiness.
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.