generated from coulomb/repo-seed
tegwick
d86b3cec14
T01: copy agent-scope-analyst.md to the-custodian/agents/
T02: add scope.template, prepend @SCOPE.md to claude-md.template,
update register_project.sh to write SCOPE.md stub on new registration,
add scope-analyst row to TOOLS.md
T03: SCOPE.md for the-custodian itself
Workplan: CUST-WP-0017 registered in state-hub
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
121 lines
2.1 KiB
Plaintext
121 lines
2.1 KiB
Plaintext
# SCOPE
|
|
|
|
> This file helps you quickly understand what this repository is about,
|
|
> when it is relevant, and when it is not.
|
|
> It is intentionally lightweight and may be incomplete.
|
|
|
|
---
|
|
|
|
## One-liner
|
|
|
|
<!-- Describe the purpose of this repository in one precise sentence. -->
|
|
<!-- Example: "Provides a lightweight event router for Kubernetes-native systems." -->
|
|
|
|
---
|
|
|
|
## Core Idea
|
|
|
|
<!-- What is the main capability or idea behind this repository? -->
|
|
<!-- What problem does it try to solve? -->
|
|
|
|
---
|
|
|
|
## In Scope
|
|
|
|
<!-- What this repository is responsible for. -->
|
|
<!-- Be explicit and concrete. -->
|
|
|
|
-
|
|
-
|
|
-
|
|
|
|
---
|
|
|
|
## Out of Scope
|
|
|
|
<!-- What this repository deliberately does NOT do. -->
|
|
<!-- This is often more important than "In Scope". -->
|
|
|
|
-
|
|
-
|
|
-
|
|
|
|
---
|
|
|
|
## Relevant When
|
|
|
|
<!-- When should someone consider using or exploring this repository? -->
|
|
|
|
-
|
|
-
|
|
-
|
|
|
|
---
|
|
|
|
## Not Relevant When
|
|
|
|
<!-- When should someone ignore this repository? -->
|
|
|
|
-
|
|
-
|
|
-
|
|
|
|
---
|
|
|
|
## Current State
|
|
|
|
<!-- Rough indication of maturity. No strict format required. -->
|
|
|
|
- Status: <!-- e.g. concept / experimental / active / stable / deprecated -->
|
|
- Implementation: <!-- e.g. idea / partial / substantial / complete -->
|
|
- Stability: <!-- e.g. unstable / evolving / stable -->
|
|
- Usage: <!-- e.g. none / personal / internal / production -->
|
|
|
|
<!-- Add any notes that help set expectations. -->
|
|
|
|
---
|
|
|
|
## How It Fits
|
|
|
|
<!-- Where does this repository sit in the bigger picture? -->
|
|
|
|
- Upstream dependencies:
|
|
- Downstream consumers:
|
|
- Often used with:
|
|
|
|
---
|
|
|
|
## Terminology
|
|
|
|
<!-- Terms that are important to understand this repo. -->
|
|
<!-- Especially useful if naming differs from other repos. -->
|
|
|
|
- Preferred terms:
|
|
- Also known as:
|
|
- Potentially confusing terms:
|
|
|
|
---
|
|
|
|
## Related / Overlapping Repositories
|
|
|
|
<!-- List repositories that have similar or adjacent responsibilities. -->
|
|
<!-- Helps detect duplication and navigate the ecosystem. -->
|
|
|
|
- <repo-name> — <!-- how it relates -->
|
|
|
|
---
|
|
|
|
## Getting Oriented
|
|
|
|
<!-- If someone decides to look deeper, where should they start? -->
|
|
|
|
- Start with:
|
|
- Key files / directories:
|
|
- Entry points:
|
|
|
|
---
|
|
|
|
## Notes
|
|
|
|
<!-- Anything else worth knowing. Keep it short. -->
|