project-doc-scaffolder
Skill8 starsChanged 6 months agoMITView on GitHub
Scaffold agent-ready project documentation for a new or existing repository, including AGENTS.md, CONTRIBUTING.md, DESIGN.md, issue templates, and pull request templates. Use when a user wants to initialize project docs for coding agents, contributors, design decisions, GitHub issues, or PR review workflows.
In this repository12 other files it gives its agents.
- create-issueSkill
- dumb-it-downSkill
- falsify-projectSkill
- from-issueSkill
- github-repo-hygieneSkill
- new-featureSkill
- overengineering-reviewSkill
- system-diagrammerSkill
- test-writerSkill
- to-adrSkill
- verify-projectSkill
- zero-techdebtSkill
The file
We split this skill into the rules it gives an agent
11 rules. About 0 are common, 9 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈9
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 10
Use this skill when a user wants a project initialized with practical Markdown files for agents and collaborators.
- Very specific: line 16
Check for existing AGENTS.md, CONTRIBUTING.md, DESIGN.md, .github/ISSUE_TEMPLATE/*, and .github/pull_request_template.md.
- Distinctive: line 19
Default: create all bundled templates.
- Distinctive: line 20
If the user names specific files, create only those files.
- Distinctive: line 21
If the project already has equivalent files, either leave them alone or make a focused patch that matches the existing style.
- Distinctive: line 22
Run the scaffold script when a full default scaffold is appropriate:
- Very specific: line 28
Use --force only when the user has explicitly approved overwriting existing files.
- Distinctive: line 32
Keep instructions concise and project-specific.
- Distinctive: line 33
Avoid vendor-specific agent names unless the user requests them.
- Distinctive: line 36
If the target is a git repository, inspect git status --short.
- Distinctive: line 49
Prefer editing the generated files in the target project instead of modifying the bundled templates unless the user is improving this skill …
≈ “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 Doc Scaffolder
Use this skill when a user wants a project initialized with practical Markdown files for agents and collaborators.
Workflow
- Inspect the target project before writing.
- Identify whether it is a git repository.
- Check for existing
AGENTS.md,CONTRIBUTING.md,DESIGN.md,.github/ISSUE_TEMPLATE/*, and.github/pull_request_template.md. - Preserve existing files unless the user explicitly asks to overwrite them.
- Choose the output set.
- Default: create all bundled templates.
- If the user names specific files, create only those files.
- If the project already has equivalent files, either leave them alone or make a focused patch that matches the existing style.
- Run the scaffold script when a full default scaffold is appropriate:
python project-doc-scaffolder/scripts/scaffold_project_docs.py /path/to/projectUse --force only when the user has explicitly approved overwriting existing files.
- Customize after scaffolding.
- Replace placeholders such as project name and default branch if they can be inferred.
- Keep instructions concise and project-specific.
- Avoid vendor-specific agent names unless the user requests them.
- Verify.
- List created and skipped files.
- If the target is a git repository, inspect
git status --short.
Template Files
Bundled templates live in assets/templates/ and map to these project paths:
AGENTS.mdCONTRIBUTING.mdDESIGN.md.github/ISSUE_TEMPLATE/bug_report.md.github/ISSUE_TEMPLATE/feature_request.md.github/pull_request_template.md
Prefer editing the generated files in the target project instead of modifying the bundled templates unless the user is improving this skill 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.

