Co-authored-by: Carlos Florencio <carlosmflorencio@gmail.com>
4.1 KiB
Specification catalog
This catalog is the entry point for the system-oriented specification layout. Each system README defines ownership, exclusions, and links to its canonical requirements and system designs.
Systems
| System | Index | Migration | Canonical documents |
|---|---|---|---|
| Agents | README | complete | 27 requirements, 17 designs |
| Auth | README | complete | 7 requirements, 2 designs |
| CLI | README | complete | 3 requirements, 1 designs |
| Costs | README | complete | 2 requirements, 0 designs |
| Desktop | README | complete | 1 requirements, 1 designs |
| Executors | README | complete | 3 requirements, 6 designs |
| Integrations | README | complete | 18 requirements, 21 designs |
| Office | README | complete | 19 requirements, 38 designs |
| Platform | README | complete | 30 requirements, 10 designs |
| Plugins | README | complete | 7 requirements, 9 designs |
| Release | README | complete | 5 requirements, 0 designs |
| System page | README | complete | 3 requirements, 5 designs |
| Tasks | README | complete | 69 requirements, 12 designs |
| UI | README | in_progress | 127 requirements, 56 designs |
| Workspaces | README | complete | 11 requirements, 3 designs |
Migration record
The legacy specification sources were migrated from the unstructured root and category directories into the system-oriented layout. Task and workflow sources from PR #2957 remain under tasks/; three task-owned sources found outside that tree were folded into the same system during this migration.
The former legacy size exceptions for migrated sources were removed. All canonical requirement and system-design documents now pass the repository specification linter.
Unmigrated additions
The following specifications were added after this migration and remain in the legacy layout until they move into an owning system:
- Task Cost & Token Ledger (draft)
- Multi-tenancy (draft)
- Startup listener before recovery (draft)
- Workflow on_enter action dispatch (draft)
- Kubernetes Executor (implemented)
- Task Delivery Ledger (draft)
- Waiting Attribution (implemented)
- ACP Form Elicitation (draft)
- Parked-Session Notification Deferral (draft)
- Workflow Engine Operation Ledger Lifetime (draft)
Authoring rule
- Spec layout. Umbrella specs live as flat
.mdfiles under the umbrella directory (docs/specs/office/agents.md). Standalone specs use a folder (docs/specs/improve-kandev/spec.md). - Plans are not specs. Implementation plans are committed under
docs/plans/<feature>/with individual sibling task files namedtask-<NN>-<short-slug>.md. Specs are the durable requirements; plans and task files are implementation records for the current buildout. - Bug fixes are not specs. Bugs produce a regression test plus an ADR if they encoded a new convention. See
/fixskill. - Architecture decisions are not specs. ADRs live under
docs/decisions/. See/record decision.
Cross-references
- ADRs:
../decisions/INDEX.md - Spec workflow:
.agents/skills/spec/SKILL.md - Bug-fix workflow:
.agents/skills/fix/SKILL.md