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
- 参考文档references/agents/exemplar.md4.8 KB
- 参考文档references/agents/rules.md1.6 KB
- 参考文档references/agents/template.md2.2 KB
- 参考文档references/agents/workflow.md3.7 KB
- 参考文档references/architecture/exemplar.md54.3 KB
- 参考文档references/architecture/rules.md4.2 KB
- 参考文档references/architecture/template.md5.6 KB
- 参考文档references/architecture/workflow.md1.2 KB
- 参考文档references/backlog/feature-exemplar.md2.7 KB
- 参考文档references/backlog/rules.md1.9 KB
- 参考文档references/backlog/shared-exemplar.md3.7 KB
- 参考文档references/backlog/surface-exemplar.md2.7 KB
- 参考文档references/backlog/template.md1.2 KB
- 参考文档references/backlog/workflow.md3.0 KB
- 参考文档references/contributing/exemplar.md1.8 KB
- 参考文档references/contributing/rules.md2.4 KB
- 参考文档references/contributing/template.md1.4 KB
- 参考文档references/contributing/workflow.md3.7 KB
- 参考文档references/data/exemplar.md1.8 KB
- 参考文档references/data/rules.md2.3 KB
- 参考文档references/data/template.md1.0 KB
- 参考文档references/data/workflow.md4.6 KB
- 参考文档references/design/exemplar.md4.1 KB
- 参考文档references/design/rules.md1.7 KB
- 参考文档references/design/template.md1.1 KB
- 参考文档references/design/workflow.md3.1 KB
- 参考文档references/frd/exemplar.md10.0 KB
- 参考文档references/frd/rules.md3.6 KB
- 参考文档references/frd/template.md2.1 KB
- 参考文档references/frd/workflow.md6.0 KB
- 参考文档references/prd/exemplar.md6.9 KB
- 参考文档references/prd/rules.md3.5 KB
- 参考文档references/prd/template.md2.5 KB
- 参考文档references/prd/workflow.md4.0 KB
- 参考文档references/readme/exemplar.md1.3 KB
- 参考文档references/readme/rules.md1.3 KB
- 参考文档references/readme/template.md378 B
- 参考文档references/readme/workflow.md3.1 KB
- 参考文档references/roadmap/exemplar.md2.4 KB
- 参考文档references/roadmap/rules.md2.2 KB
- 参考文档references/roadmap/template.md1.6 KB
- 参考文档references/roadmap/workflow.md3.0 KB
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/DESIGNstate intent,BACKLOGandROADMAPstate 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/BACKLOGlive per feature folder;DESIGNper surface folder;DATAper shared folder. - Feature folders carry
FRD.mdandBACKLOG.md; a folder with neither capabilities nor an agent is not a feature and owes no document pair (AES702). - Surface folders carry
DESIGN.mdwith 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
github-workflow
Umbrella for GitHub auth, repo management, issues, PRs, Mergify, and releases. Subsumes github-auth and repo-manager.
brave-automation
baa CLI: Brave profiles, Google sessions, credentials.
aes
AES docs, layers, rule fixes, and legacy migration.
pretext
Build creative browser demos with DOM-free text layout.
popular-web-designs
54 real design systems (Stripe, Linear, Vercel) as HTML/CSS.
p5js
p5.js sketches: gen art, shaders, interactive, 3D.