AGENT SKILL

aes-docs

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.

License 许可
MIT
最近更新
2026-11-15
Stars
★ 0
Forks
0

01 前言 Front Matter

name
aes-docs
description
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.
when-to-use
create, improve, or audit a project document (PRD, ROADMAP, FRD, BACKLOG, README, AGENTS, ARCHITECTURE, CONTRIBUTING, DESIGN, DATA); split spec from status; verify docs with lint-arwaky-cli docs.
argument-hint
<improve | make | design> [document type] [path]

02 资源文件 42

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

Document Location Focus Files
PRD.md Root workspace What & Why rules · exemplar · template · workflow
ROADMAP.md Root workspace How the priority progresses rules · exemplar · template · workflow
FRD.md Each feature folder How functionally rules · exemplar · template · workflow
BACKLOG.md Each feature, surface, or shared folder What is true now rules · feature-exemplar · surface-exemplar · shared-exemplar · template · workflow
README.md Root workspace How to use/run rules · exemplar · template · workflow
AGENTS.md Root workspace How to work here safely rules · exemplar · template · workflow
ARCHITECTURE.md Root workspace Layer boundaries and allowed dependencies rules · exemplar · template · workflow
CONTRIBUTING.md Root workspace How to set up and ship a change rules · exemplar · template · workflow
DESIGN.md Each surface folder Visual & interaction contract rules · exemplar · template · workflow
DATA.md Shared folder What the shared layer manages rules · exemplar · template · workflow

04 同仓库更多 Skills