Files
kandev/docs/specs/templates/system-readme.md
T
2026-09-12 17:23:20 +01:00

987 B

status, system, specification_version, migration, owners
status system specification_version migration owners
draft <system-slug> 1 <in_progress|complete>
<owner>

Purpose

Describe the capability and the actors or consumers that use it.

Ownership

List the concepts, behavior, data, and contracts that this system owns.

Exclusions

List adjacent concepts that another system owns. Link to that system.

Find specifications

Use the catalog command to list this system's current documents:

python3 scripts/list-docs.py specs --system <system-slug> --format markdown
python3 scripts/list-docs.py specs --system <system-slug> --kind requirement --format paths
python3 scripts/list-docs.py specs --system <system-slug> --kind system-design --format paths

Do not copy the command output into this README. Keep this file focused on the system boundary, migration record, and related systems.

  • System: Describe the dependency direction.