Index of every page on this site: llms.txt
All skills
masihmoafi avatar

/project-docs

@c0a5d13
by Masih Moafimasihmoafi/skills10 stars
Run it yourself

Use when entering an unfamiliar project, when creating or repairing a project's agent docs (AGENTS.md, feature map, lat.md folder map, VISION.md, ES.md), or when the workspace check reports doc problems.

  • 1 file
  • 3.5 KB
  • Updated 3 weeks ago
  • GitHub
Use this Skill: https://skilld.dev/gh/masihmoafi/skills/project-docs

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈54 tokens for metadata: the name and description. ≈823 when used: this file.

Description uses 2.7% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈218 characters, or 2.7%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Project docs

Each fact about a project has one home. Read in this order: AGENTS.md (loaded already), ES.md, then the feature file for the task. Use the folder map before you add a file and VISION.md when scope is in question. A README supplements these files; it never replaces them.

One file per job

File Holds Limit
AGENTS.md (+ CLAUDE.md = @AGENTS.md) ## Start here (pointers), ## Common mistakes (this project's lessons), ## Rules 60 lines
ES.md, title "(updated YYYY-MM-DD)" ## Now, ## Next, ## Broken, ## Open decisions 40 lines
VISION.md identity in one line, ## Thesis, ## Non-goals 25 lines
lat.md/workspace.md every top-level item and why it exists —
.agents/skills/verify-<app>/features/ one file per user-facing feature: how to reach it, drive it, its code, its gotchas; made by create-verification-skill, kept true by maintain-verification-skill —
reports/, commit messages evidence: hashes, run IDs, verification prose —

A workspace check can enforce the limits and headings (here: findability/check_pointers.py). These files are local notes: keep them out of public git and link them into new worktrees.

What goes in AGENTS.md

It loads into every session, so each line must apply to every task there (HumanLayer, Writing a Good CLAUDE.md; Anthropic, Steering Claude Code).

  • Yes: what the project is, how to build, test and verify it, where things live (as pointers), and rules that hold for every task.
  • No: procedures (a skill), task-specific notes (the feature file), state (ES.md), copies of global rules (the user-level instructions), code style (a linter).
  • A "never do X" that agents keep breaking needs a check or hook; the line in AGENTS.md is not enough.
  • A common mistake is one dated line: what went wrong, the rule, and its guard (or "No guard").

What goes in ES.md

  • ## Now: what is true today, in up to five lines. Each line states a fact; its proof goes to reports/.
  • ## Next: the user's open requests, newest date first, one line each, starting Feature:, Fix:, Remove: or Keep:. Delete a line only when the user has seen it working. When the log outgrows the file, it moves to a local REQUESTS.md beside ES.md (same line format), and ## Next keeps the user's ranked items and a link.
  • ## Broken and ## Open decisions: one line each; a decision names who decides.
  • Rewrite the file in place; never append a progress log.

Keep them true

  • Change a fact in its home only; elsewhere, point to it.
  • When a doc contradicts the code or another doc, check the code, fix or delete the wrong text, and say what changed.
  • Before you delete old text, move each lesson or prohibition that is still valid to a feature's gotchas or to AGENTS.md.
  • Add a harness part (init.sh, a rubric, a lint) only for a workflow that repeats, and only the smallest that fixes the bottleneck. If you are not sure it is still needed, remove it and keep the simpler setup if quality holds.

Create the layout when absent

Inspect the project two levels deep, draft the missing files in the shape above, and show the user VISION.md before you save it. Exemplar: this library's VISION.md.

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No third-party reports yet.

Signed by skilld at c0a5d13. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub last week.

Activeupdated 3 weeks ago

README badge

README badge for masihmoafi/skills/project-docs