agentleFS
Sign inStart free
cablatecablate/ai-toolkit/skills/project-docs/SKILL.md

project-docs

Skill15 starsChanged 8 months agoMITView on GitHub

Project documentation structure — standard proj-[name]/ layout with ADRs, stories, and operations guides. Use when: initializing docs for a new project, recording architecture decisions, or maintaining project knowledge bases.

22 other projects use a version of this.

Adopted by

Most recently taken up by

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.
  • BlockSkill

    test-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

  • GoogleSkill

    to-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 CloudSkill

    triage

    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

The file

We split this skill into the rules it gives an agent

2 rules. 0 are common, 1 is distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 18 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Create the directory structure above

    line 38
  2. Very specific:

    Document system/overview.md — What does the system look like now?

    line 41

“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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Project Documentation

Core Principles

  • Docs are for future you — Good docs let you resume context in 5 minutes after 3 months away
  • Record decisions, not just results — "We use X" is not enough. Record "why X, not Y"

Project Docs Structure

Each project gets a proj-[name]/ directory:

proj-[name]/
├── SKILL.md                    # Project entry point (concise summary)
└── references/
    ├── _index.md               # Navigation guide
    ├── product/
    │   ├── vision.md           # What problem this project solves
    │   └── principles.md       # Core development principles
    ├── system/
    │   └── overview.md         # System architecture overview
    ├── decisions/
    │   ├── _index.md           # Decision index
    │   ├── adr/                # Architecture Decision Records
    │   └── stories/            # Feature stories
    └── operations/
        ├── quick-nav.md        # Quick navigation
        └── troubleshooting.md  # Common issues & solutions

Initializing a New Project

  1. Create the directory structure above
  2. Fill product/vision.md — What problem does this project solve?
  3. Define product/principles.md — What are the core development principles?
  4. Document system/overview.md — What does the system look like now?
  5. Backfill decisions/adr/ — Record important technical choices already made

See doc-standards.md for ADR format, story format, and naming conventions.

References

FileContent
doc-standards.mdDocument formats and templates

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.

Check your setup, free