agentleFS
rakaarwakyrakaarwaky/agents-arwaky/skills/architechture/aes-docs/SKILL.md

aes-docs

Skill0 starsChanged 4 days agoMITView on GitHub

Adds PRD/ROADMAP/FRD/README/BACKLOG/DESIGN/AGENTS/DATA docs for Python, Rust, and TypeScript modules. Use when creating or improving a PRD, ROADMAP, FRD, BACKLOG, README, AGENTS, DESIGN, or DATA document, or to split spec from status.

The file

We split this skill into the rules it gives an agent

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    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. Very specific:

    Verify: lint-arwaky-cli docs <workspace> passes — the document-invariant gate resolves every link and reports any pointer into nothing.

    line 20

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

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

aes-docs

Scaffold and audit the ten AES project documents — PRD, ROADMAP, FRD, BACKLOG, README, AGENTS, ARCHITECTURE, CONTRIBUTING, DESIGN, DATA — each with its own rules, exemplar, template, and workflow file under references/. The audience is the agent creating or improving a project document; the document type decides which reference set loads and which gate applies. A missing document is diagnosed by its reader's question — the reader who could not answer the question is the document to write. Invariants read by more than one step live in Global Rules below.

Global Rules

  • Split spec from status: PRD / FRD / DESIGN state intent, BACKLOG and ROADMAP state what is true now — status words never appear in spec documents (status-in-spec).
  • One document per reader: root documents (PRD, ROADMAP, README, AGENTS, ARCHITECTURE, CONTRIBUTING) live at the workspace root; FRD / BACKLOG live per feature folder; DESIGN per surface folder; DATA per shared folder.
  • Feature folders carry FRD.md and BACKLOG.md; a folder with neither capabilities nor an agent is not a feature and owes no document pair (AES702).
  • Surface folders carry DESIGN.md with the six sections — Kind, Entry Points, Request Shape, States, Error States, Invariants, Change Checklist; every row names this folder's real files (AES703).
  • Improve vs make: audit mode checks each document against its rules file and exemplar; make mode scaffolds from the template file in the same reference set.
  • Verify: lint-arwaky-cli docs <workspace> passes — the document-invariant gate resolves every link and reports any pointer into nothing.
  • One fact, one home: each references/<doc>/ set owns that document's shape — rules, exemplar, template, workflow. Read it, do not restate here. Cite the gate, not this file, when pointing at a rule. Each bullet states a fact once; references point at the bullet.

Routing

workflow.md is the entry point for each doc type; the other files in the set load on demand.

DocumentLocationFocusFiles
PRD.mdRoot workspaceWhat & Whyrules · exemplar · template · workflow
ROADMAP.mdRoot workspaceHow the priority progressesrules · exemplar · template · workflow
FRD.mdEach feature folderHow functionallyrules · exemplar · template · workflow
BACKLOG.mdEach feature, surface, or shared folderWhat is true nowrules · feature-exemplar · surface-exemplar · shared-exemplar · template · workflow
README.mdRoot workspaceHow to use/runrules · exemplar · template · workflow
AGENTS.mdRoot workspaceHow to work here safelyrules · exemplar · template · workflow
ARCHITECTURE.mdRoot workspaceLayer boundaries and allowed dependenciesrules · exemplar · template · workflow
CONTRIBUTING.mdRoot workspaceHow to set up and ship a changerules · exemplar · template · workflow
DESIGN.mdEach surface folderVisual & interaction contractrules · exemplar · template · workflow
DATA.mdShared folderWhat the shared layer managesrules · exemplar · template · workflow

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.