@trespies-source/dojo-genesis-plugin 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +30 -0
- package/LICENSE +21 -0
- package/README.md +204 -0
- package/dist/hooks/after-tool-call/handler.d.ts +4 -0
- package/dist/hooks/after-tool-call/handler.d.ts.map +1 -0
- package/dist/hooks/after-tool-call/handler.js +37 -0
- package/dist/hooks/after-tool-call/handler.js.map +1 -0
- package/dist/hooks/agent-end/handler.d.ts +4 -0
- package/dist/hooks/agent-end/handler.d.ts.map +1 -0
- package/dist/hooks/agent-end/handler.js +16 -0
- package/dist/hooks/agent-end/handler.js.map +1 -0
- package/dist/hooks/before-agent-start/handler.d.ts +4 -0
- package/dist/hooks/before-agent-start/handler.d.ts.map +1 -0
- package/dist/hooks/before-agent-start/handler.js +81 -0
- package/dist/hooks/before-agent-start/handler.js.map +1 -0
- package/dist/index.d.ts +18 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +35 -0
- package/dist/index.js.map +1 -0
- package/dist/src/commands/archive.d.ts +4 -0
- package/dist/src/commands/archive.d.ts.map +1 -0
- package/dist/src/commands/archive.js +20 -0
- package/dist/src/commands/archive.js.map +1 -0
- package/dist/src/commands/init.d.ts +4 -0
- package/dist/src/commands/init.d.ts.map +1 -0
- package/dist/src/commands/init.js +57 -0
- package/dist/src/commands/init.js.map +1 -0
- package/dist/src/commands/list.d.ts +4 -0
- package/dist/src/commands/list.d.ts.map +1 -0
- package/dist/src/commands/list.js +9 -0
- package/dist/src/commands/list.js.map +1 -0
- package/dist/src/commands/router.d.ts +3 -0
- package/dist/src/commands/router.d.ts.map +1 -0
- package/dist/src/commands/router.js +83 -0
- package/dist/src/commands/router.js.map +1 -0
- package/dist/src/commands/skill-invoke.d.ts +4 -0
- package/dist/src/commands/skill-invoke.d.ts.map +1 -0
- package/dist/src/commands/skill-invoke.js +26 -0
- package/dist/src/commands/skill-invoke.js.map +1 -0
- package/dist/src/commands/status.d.ts +4 -0
- package/dist/src/commands/status.d.ts.map +1 -0
- package/dist/src/commands/status.js +42 -0
- package/dist/src/commands/status.js.map +1 -0
- package/dist/src/commands/switch.d.ts +4 -0
- package/dist/src/commands/switch.d.ts.map +1 -0
- package/dist/src/commands/switch.js +20 -0
- package/dist/src/commands/switch.js.map +1 -0
- package/dist/src/orchestration/tool-registry.d.ts +18 -0
- package/dist/src/orchestration/tool-registry.d.ts.map +1 -0
- package/dist/src/orchestration/tool-registry.js +153 -0
- package/dist/src/orchestration/tool-registry.js.map +1 -0
- package/dist/src/skills/catalog.d.ts +9 -0
- package/dist/src/skills/catalog.d.ts.map +1 -0
- package/dist/src/skills/catalog.js +251 -0
- package/dist/src/skills/catalog.js.map +1 -0
- package/dist/src/state/manager.d.ts +19 -0
- package/dist/src/state/manager.d.ts.map +1 -0
- package/dist/src/state/manager.js +114 -0
- package/dist/src/state/manager.js.map +1 -0
- package/dist/src/state/migrations.d.ts +3 -0
- package/dist/src/state/migrations.d.ts.map +1 -0
- package/dist/src/state/migrations.js +8 -0
- package/dist/src/state/migrations.js.map +1 -0
- package/dist/src/state/types.d.ts +62 -0
- package/dist/src/state/types.d.ts.map +1 -0
- package/dist/src/state/types.js +2 -0
- package/dist/src/state/types.js.map +1 -0
- package/dist/src/ui/chat-formatter.d.ts +11 -0
- package/dist/src/ui/chat-formatter.d.ts.map +1 -0
- package/dist/src/ui/chat-formatter.js +39 -0
- package/dist/src/ui/chat-formatter.js.map +1 -0
- package/dist/src/utils/file-ops.d.ts +6 -0
- package/dist/src/utils/file-ops.d.ts.map +1 -0
- package/dist/src/utils/file-ops.js +38 -0
- package/dist/src/utils/file-ops.js.map +1 -0
- package/dist/src/utils/markdown.d.ts +2 -0
- package/dist/src/utils/markdown.d.ts.map +1 -0
- package/dist/src/utils/markdown.js +11 -0
- package/dist/src/utils/markdown.js.map +1 -0
- package/dist/src/utils/validation.d.ts +7 -0
- package/dist/src/utils/validation.d.ts.map +1 -0
- package/dist/src/utils/validation.js +29 -0
- package/dist/src/utils/validation.js.map +1 -0
- package/dist/tests/__mocks__/openclaw-types.d.ts +54 -0
- package/dist/tests/__mocks__/openclaw-types.d.ts.map +1 -0
- package/dist/tests/__mocks__/openclaw-types.js +29 -0
- package/dist/tests/__mocks__/openclaw-types.js.map +1 -0
- package/hooks/after-tool-call/HOOK.md +7 -0
- package/hooks/after-tool-call/handler.ts +41 -0
- package/hooks/agent-end/HOOK.md +7 -0
- package/hooks/agent-end/handler.ts +18 -0
- package/hooks/before-agent-start/HOOK.md +7 -0
- package/hooks/before-agent-start/handler.ts +133 -0
- package/openclaw.plugin.json +19 -0
- package/package.json +61 -0
- package/skills/agent-teaching/SKILL.md +583 -0
- package/skills/agent-teaching/claw.json +12 -0
- package/skills/compression-ritual/SKILL.md +136 -0
- package/skills/compression-ritual/claw.json +12 -0
- package/skills/context-ingestion/SKILL.md +109 -0
- package/skills/context-ingestion/claw.json +12 -0
- package/skills/decision-propagation/SKILL.md +130 -0
- package/skills/decision-propagation/claw.json +12 -0
- package/skills/documentation-audit/SKILL.md +146 -0
- package/skills/documentation-audit/claw.json +12 -0
- package/skills/era-architecture/SKILL.md +166 -0
- package/skills/era-architecture/claw.json +12 -0
- package/skills/file-management/SKILL.md +127 -0
- package/skills/file-management/claw.json +12 -0
- package/skills/frontend-from-backend/SKILL.md +127 -0
- package/skills/frontend-from-backend/claw.json +12 -0
- package/skills/handoff-protocol/SKILL.md +168 -0
- package/skills/handoff-protocol/claw.json +12 -0
- package/skills/health-audit/SKILL.md +123 -0
- package/skills/health-audit/claw.json +12 -0
- package/skills/implementation-prompt/SKILL.md +361 -0
- package/skills/implementation-prompt/claw.json +12 -0
- package/skills/iterative-scouting/SKILL.md +106 -0
- package/skills/iterative-scouting/claw.json +12 -0
- package/skills/memory-garden/SKILL.md +470 -0
- package/skills/memory-garden/claw.json +12 -0
- package/skills/multi-surface-strategy/SKILL.md +288 -0
- package/skills/multi-surface-strategy/claw.json +12 -0
- package/skills/parallel-tracks/SKILL.md +152 -0
- package/skills/parallel-tracks/claw.json +12 -0
- package/skills/patient-learning-protocol/SKILL.md +438 -0
- package/skills/patient-learning-protocol/claw.json +12 -0
- package/skills/planning-with-files/SKILL.md +139 -0
- package/skills/planning-with-files/claw.json +12 -0
- package/skills/pre-implementation-checklist/SKILL.md +156 -0
- package/skills/pre-implementation-checklist/claw.json +12 -0
- package/skills/process-extraction/SKILL.md +148 -0
- package/skills/process-extraction/claw.json +12 -0
- package/skills/process-extraction/references/process_example_template.md +40 -0
- package/skills/product-positioning/SKILL.md +293 -0
- package/skills/product-positioning/claw.json +12 -0
- package/skills/project-exploration/SKILL.md +168 -0
- package/skills/project-exploration/claw.json +12 -0
- package/skills/release-specification/SKILL.md +645 -0
- package/skills/release-specification/claw.json +12 -0
- package/skills/repo-context-sync/SKILL.md +362 -0
- package/skills/repo-context-sync/claw.json +12 -0
- package/skills/repo-context-sync/references/file_hierarchy_patterns.md +186 -0
- package/skills/repo-context-sync/references/zenflow_repo_patterns.md +328 -0
- package/skills/repo-context-sync/scripts/context_mapper.py +251 -0
- package/skills/repo-context-sync/scripts/diff_tracker.py +187 -0
- package/skills/repo-context-sync/scripts/smart_clone.sh +52 -0
- package/skills/repo-context-sync/templates/context_summary.md +58 -0
- package/skills/repo-status/SKILL.md +240 -0
- package/skills/repo-status/claw.json +12 -0
- package/skills/repo-status/references/semantic-clusters.md +159 -0
- package/skills/repo-status/references/status-template.md +214 -0
- package/skills/research-modes/SKILL.md +515 -0
- package/skills/research-modes/claw.json +12 -0
- package/skills/research-synthesis/SKILL.md +110 -0
- package/skills/research-synthesis/claw.json +12 -0
- package/skills/retrospective/SKILL.md +152 -0
- package/skills/retrospective/claw.json +12 -0
- package/skills/seed-extraction/SKILL.md +419 -0
- package/skills/seed-extraction/claw.json +12 -0
- package/skills/seed-library/SKILL.md +424 -0
- package/skills/seed-library/claw.json +12 -0
- package/skills/seed-library/references/seed_catalog.md +171 -0
- package/skills/seed-library/scripts/apply_seed.py +129 -0
- package/skills/seed-library/scripts/suggest_seeds.py +183 -0
- package/skills/seed-library/seeds/01_three_tiered_governance.md +90 -0
- package/skills/seed-library/seeds/02_harness_trace.md +135 -0
- package/skills/seed-library/seeds/03_context_iceberg.md +120 -0
- package/skills/seed-library/seeds/04_agent_connect.md +106 -0
- package/skills/seed-library/seeds/05_go_live_bundles.md +40 -0
- package/skills/seed-library/seeds/06_cost_guard.md +40 -0
- package/skills/seed-library/seeds/07_safety_switch.md +41 -0
- package/skills/seed-library/seeds/08_implicit_perspective_extraction.md +41 -0
- package/skills/seed-library/seeds/09_mode_based_complexity_gating.md +46 -0
- package/skills/seed-library/seeds/10_shared_infrastructure.md +75 -0
- package/skills/seed-library/seeds/11_voice_before_structure.md +74 -0
- package/skills/seed-library/seeds/12_pointer_directories.md +81 -0
- package/skills/seed-library/seeds/13_granular_visibility.md +82 -0
- package/skills/seed-library/seeds/meta_governance_multiplies_velocity.md +43 -0
- package/skills/seed-to-skill-converter/SKILL.md +113 -0
- package/skills/seed-to-skill-converter/claw.json +12 -0
- package/skills/semantic-clusters/SKILL.md +246 -0
- package/skills/semantic-clusters/claw.json +12 -0
- package/skills/semantic-clusters/references/verb-catalog.md +267 -0
- package/skills/skill-audit-upgrade/SKILL.md +427 -0
- package/skills/skill-audit-upgrade/claw.json +12 -0
- package/skills/skill-creation/LICENSE.txt +202 -0
- package/skills/skill-creation/SKILL.md +252 -0
- package/skills/skill-creation/claw.json +12 -0
- package/skills/skill-creation/references/output-patterns.md +82 -0
- package/skills/skill-creation/references/progressive-disclosure-patterns.md +79 -0
- package/skills/skill-creation/references/workflows.md +28 -0
- package/skills/skill-creation/scripts/init_skill.py +305 -0
- package/skills/skill-creation/scripts/quick_validate.py +134 -0
- package/skills/skill-maintenance/SKILL.md +413 -0
- package/skills/skill-maintenance/claw.json +12 -0
- package/skills/spec-constellation-to-prompt-suite/SKILL.md +174 -0
- package/skills/spec-constellation-to-prompt-suite/claw.json +12 -0
- package/skills/status-template/SKILL.md +211 -0
- package/skills/status-template/claw.json +12 -0
- package/skills/status-template/references/complete-template.md +191 -0
- package/skills/status-writing/SKILL.md +161 -0
- package/skills/status-writing/claw.json +12 -0
- package/skills/strategic-scout/SKILL.md +163 -0
- package/skills/strategic-scout/claw.json +12 -0
- package/skills/strategic-to-tactical-workflow/SKILL.md +391 -0
- package/skills/strategic-to-tactical-workflow/claw.json +12 -0
- package/skills/workspace-navigation/SKILL.md +622 -0
- package/skills/workspace-navigation/claw.json +12 -0
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
# Semantic Action-Verb Clusters — Reference Guide
|
|
2
|
+
|
|
3
|
+
**Purpose:** This reference explains how to identify, assign, and maintain semantic clusters when generating a `.status.md` for a software repository.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## What Are Semantic Clusters?
|
|
8
|
+
|
|
9
|
+
Most codebases are organized by *where files live* (directories, packages, modules). Semantic clusters reorganize the same codebase by *what it does* — each cluster is named with an action verb that captures a behavioral capability.
|
|
10
|
+
|
|
11
|
+
This matters because:
|
|
12
|
+
- A feature often spans multiple directories (frontend + backend + database + tests)
|
|
13
|
+
- A directory often contains components serving different purposes
|
|
14
|
+
- Understanding a system's *capabilities* is more useful than understanding its *file layout*
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## The Starter Verbs
|
|
19
|
+
|
|
20
|
+
These 13 verbs cover most software systems. Not every project needs all of them, and some projects will need verbs not on this list.
|
|
21
|
+
|
|
22
|
+
### CONVERSE
|
|
23
|
+
**Meaning:** The system communicates with users in real-time.
|
|
24
|
+
**Typical components:** Chat UI, message models, WebSocket/SSE handlers, input components, notification systems.
|
|
25
|
+
**Signals you need this cluster:** The app has a chat, messaging, or real-time communication feature.
|
|
26
|
+
|
|
27
|
+
### REASON
|
|
28
|
+
**Meaning:** The system thinks, plans, or makes decisions.
|
|
29
|
+
**Typical components:** AI agents, intent classifiers, orchestration engines, DAG planners, rule engines, recommendation systems.
|
|
30
|
+
**Signals:** The app has an AI agent, a planning system, or automated decision-making.
|
|
31
|
+
|
|
32
|
+
### REMEMBER
|
|
33
|
+
**Meaning:** The system stores and recalls knowledge over time.
|
|
34
|
+
**Typical components:** Memory systems, caching layers, embeddings, vector search, knowledge bases, seed/snippet systems.
|
|
35
|
+
**Signals:** The app has a memory, knowledge base, or learning component that persists across sessions.
|
|
36
|
+
|
|
37
|
+
### OBSERVE
|
|
38
|
+
**Meaning:** The system watches itself and reports what it sees.
|
|
39
|
+
**Typical components:** Trace loggers, metrics collectors, event buses, cost trackers, monitoring dashboards, audit logs.
|
|
40
|
+
**Signals:** The app has logging, tracing, analytics, or monitoring features.
|
|
41
|
+
|
|
42
|
+
### LEARN
|
|
43
|
+
**Meaning:** The system adapts based on feedback or patterns.
|
|
44
|
+
**Typical components:** Calibration engines, feedback systems, preference learning, A/B testing, recommendation tuning.
|
|
45
|
+
**Signals:** The app changes its behavior based on user feedback or observed patterns.
|
|
46
|
+
|
|
47
|
+
### ACT
|
|
48
|
+
**Meaning:** The system does things in the world.
|
|
49
|
+
**Typical components:** Tool registries, API clients, file operations, email senders, webhook dispatchers, cron jobs.
|
|
50
|
+
**Signals:** The app executes side effects — writes files, calls APIs, sends emails, triggers external systems.
|
|
51
|
+
|
|
52
|
+
### PROTECT
|
|
53
|
+
**Meaning:** The system enforces boundaries and safety.
|
|
54
|
+
**Typical components:** Auth middleware, RBAC, encryption, secure storage, rate limiters, input validation, CSRF protection.
|
|
55
|
+
**Signals:** The app has authentication, authorization, or security features.
|
|
56
|
+
|
|
57
|
+
### CONNECT
|
|
58
|
+
**Meaning:** The system integrates with external services.
|
|
59
|
+
**Typical components:** Plugin systems, gRPC/REST clients, OAuth flows, webhook receivers, bot integrations, import/export.
|
|
60
|
+
**Signals:** The app talks to third-party services, has a plugin architecture, or supports integrations.
|
|
61
|
+
|
|
62
|
+
### PRESENT
|
|
63
|
+
**Meaning:** The system renders UI for humans.
|
|
64
|
+
**Typical components:** Layout shells, routing, component libraries, style systems, theme engines, responsive breakpoints.
|
|
65
|
+
**Signals:** The app has a user-facing frontend.
|
|
66
|
+
|
|
67
|
+
### PERSIST
|
|
68
|
+
**Meaning:** The system stores data durably.
|
|
69
|
+
**Typical components:** Database managers, ORMs, migration systems, seed data, backup scripts, cache layers.
|
|
70
|
+
**Signals:** The app has a database, file storage, or persistent state.
|
|
71
|
+
|
|
72
|
+
### BUILD
|
|
73
|
+
**Meaning:** The system builds, tests, and ships itself.
|
|
74
|
+
**Typical components:** CI/CD workflows, Docker configs, build scripts, test suites, linters, release automation.
|
|
75
|
+
**Signals:** The project has CI/CD, Dockerfiles, or build scripts.
|
|
76
|
+
|
|
77
|
+
### THINK
|
|
78
|
+
**Meaning:** The system reasons about itself at a meta level.
|
|
79
|
+
**Typical components:** Skills, prompts, templates, knowledge artifacts, retrospectives, design documents.
|
|
80
|
+
**Signals:** The project has a meta-cognitive layer — skills, prompts, or structured thinking artifacts.
|
|
81
|
+
|
|
82
|
+
### ORCHESTRATE
|
|
83
|
+
**Meaning:** The system coordinates multi-step work.
|
|
84
|
+
**Typical components:** DAG engines, task queues, workflow managers, saga patterns, state machines.
|
|
85
|
+
**Signals:** The app decomposes complex tasks into sub-tasks and manages their execution.
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## How to Assign Clusters
|
|
90
|
+
|
|
91
|
+
### Step 1: Walk the inventory
|
|
92
|
+
|
|
93
|
+
For each significant component found during the deep inventory (Phase 2), ask: **"What verb describes what this does?"**
|
|
94
|
+
|
|
95
|
+
Most components map clearly to one verb. Some map to two (cross-cluster). Very few map to three or more — if they do, the component may be doing too much.
|
|
96
|
+
|
|
97
|
+
### Step 2: Build the component table
|
|
98
|
+
|
|
99
|
+
For each cluster, create a table:
|
|
100
|
+
|
|
101
|
+
```markdown
|
|
102
|
+
| Component | Location | Status | LOC |
|
|
103
|
+
|-----------|----------|--------|-----|
|
|
104
|
+
| ChatContext | frontend/src/features/chat/contexts/ | Active | 1,434 |
|
|
105
|
+
| MessageList | frontend/src/components/chat/ | Active | ~2,000 |
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Step 3: Assess cluster health
|
|
109
|
+
|
|
110
|
+
After the table, write 2-3 lines:
|
|
111
|
+
- **Health:** Overall status with emoji (✅/🔄/⚠️/❌)
|
|
112
|
+
- **Audit Notes:** Key technical details, constraints, or risks
|
|
113
|
+
|
|
114
|
+
### Step 4: Identify cross-cluster components
|
|
115
|
+
|
|
116
|
+
Some components serve multiple clusters. List these in a separate table under the PRESENT cluster (since they're usually frontend components that bridge behavioral layers):
|
|
117
|
+
|
|
118
|
+
```markdown
|
|
119
|
+
| Component | Directory | Primary Cluster | Notes |
|
|
120
|
+
|-----------|-----------|----------------|-------|
|
|
121
|
+
| vision/ | components/vision/ | ACT | Image analysis via tool execution |
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### Step 5: Identify backend-only integrations
|
|
125
|
+
|
|
126
|
+
Some backend services have no frontend counterpart. Note these explicitly so future developers know the UI gap is intentional (or a TODO).
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## Creating New Verbs
|
|
131
|
+
|
|
132
|
+
If a component doesn't fit any of the 13 starter verbs, create a new one. Good custom verbs:
|
|
133
|
+
|
|
134
|
+
- **TRANSLATE** — For i18n-heavy apps
|
|
135
|
+
- **SIMULATE** — For apps with simulation engines
|
|
136
|
+
- **COMPOSE** — For content creation tools (editors, IDEs)
|
|
137
|
+
- **GOVERN** — For apps with complex compliance/policy systems
|
|
138
|
+
- **DISCOVER** — For search-heavy or recommendation apps
|
|
139
|
+
|
|
140
|
+
Bad custom verbs (too vague):
|
|
141
|
+
- MANAGE (manage what?)
|
|
142
|
+
- PROCESS (process what?)
|
|
143
|
+
- HANDLE (handle what?)
|
|
144
|
+
|
|
145
|
+
The verb should be specific enough that reading it tells you what the cluster *does*.
|
|
146
|
+
|
|
147
|
+
---
|
|
148
|
+
|
|
149
|
+
## Common Pitfalls
|
|
150
|
+
|
|
151
|
+
1. **Over-clustering:** Don't create 30 clusters for a 50-file project. If a cluster has only 1-2 components, merge it with a related cluster.
|
|
152
|
+
|
|
153
|
+
2. **Under-clustering:** Don't dump everything into "PRESENT" and "PERSIST". If a cluster has 20+ components, consider splitting it.
|
|
154
|
+
|
|
155
|
+
3. **Confusing location with behavior:** A file in `frontend/src/components/` isn't automatically in the PRESENT cluster. A dashboard component that displays traces belongs in OBSERVE.
|
|
156
|
+
|
|
157
|
+
4. **Ignoring test files:** Tests belong in BUILD, not in the cluster of the code they test. They're part of the build and verify pipeline.
|
|
158
|
+
|
|
159
|
+
5. **Forgetting infrastructure:** CI/CD, Docker, and deployment configs are real features of the system. They belong in BUILD.
|
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
# .status.md Output Template
|
|
2
|
+
|
|
3
|
+
**Purpose:** This is the complete template for the `.status.md` file generated by the repo-status skill. Copy and fill in each section. Delete placeholder comments before saving.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
```markdown
|
|
8
|
+
# [Project Name] — Comprehensive System Status
|
|
9
|
+
|
|
10
|
+
**Author:** [Who generated this]
|
|
11
|
+
**Status:** [Active & Evolving | On Hold | Complete]
|
|
12
|
+
**Last Updated:** [YYYY-MM-DD]
|
|
13
|
+
**Methodology:** repo-status skill (status-writing + file-management + health-audit)
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## 1. Vision & Purpose
|
|
18
|
+
|
|
19
|
+
> [One compelling sentence capturing what this project is and why it exists.]
|
|
20
|
+
|
|
21
|
+
**Core Principles:** [3-5 comma-separated principles, e.g., Privacy-first, Observable, Adaptive]
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## 2. Current State
|
|
26
|
+
|
|
27
|
+
[A 1-2 sentence summary of the project's current phase.]
|
|
28
|
+
|
|
29
|
+
| Area | Status | Notes |
|
|
30
|
+
| :--- | :--- | :--- |
|
|
31
|
+
| **[Major Area 1]** | [emoji] | [Brief note] |
|
|
32
|
+
| **[Major Area 2]** | [emoji] | [Brief note] |
|
|
33
|
+
| **[Major Area 3]** | [emoji] | [Brief note] |
|
|
34
|
+
<!-- Add rows for each major subsystem, version, or workstream -->
|
|
35
|
+
|
|
36
|
+
**Status Key:**
|
|
37
|
+
- ✅ **Complete/Healthy:** Done and verified.
|
|
38
|
+
- 🔄 **In Progress:** Actively being worked on.
|
|
39
|
+
- ⏸️ **Paused:** Intentionally on hold.
|
|
40
|
+
- ⚠️ **Concern:** Needs attention but not blocking.
|
|
41
|
+
- ❌ **Blocked/Critical:** Halted or failing.
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## 3. Directory Structure & Folder Status
|
|
46
|
+
|
|
47
|
+
<!-- Annotated tree. Every line gets a status emoji and a short note.
|
|
48
|
+
Use 📦 for legacy/deprecated. Use — for empty/minimal. -->
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
project-root/ [emoji] [note]
|
|
52
|
+
├── [dir1]/ [emoji] [note]
|
|
53
|
+
│ ├── [subdir1]/ [emoji] [note]
|
|
54
|
+
│ └── [subdir2]/ [emoji] [note]
|
|
55
|
+
├── [dir2]/ [emoji] [note]
|
|
56
|
+
└── [file1] [emoji] [note]
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## 4. Semantic Action-Verb Clusters
|
|
62
|
+
|
|
63
|
+
<!-- One subsection per cluster. Include only clusters that apply. -->
|
|
64
|
+
|
|
65
|
+
### [emoji] [VERB] — [Short Description]
|
|
66
|
+
|
|
67
|
+
> [One sentence explaining what this capability means for the system.]
|
|
68
|
+
|
|
69
|
+
| Component | Location | Status | LOC |
|
|
70
|
+
|-----------|----------|--------|-----|
|
|
71
|
+
| [Name] | [path/to/component/] | [emoji] | [number] |
|
|
72
|
+
<!-- Add all components that belong to this cluster -->
|
|
73
|
+
|
|
74
|
+
**Health:** [emoji] [1-line assessment]
|
|
75
|
+
**Audit Notes:** [Key technical details, constraints, risks. 1-2 lines max.]
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
<!-- Repeat for each cluster -->
|
|
80
|
+
|
|
81
|
+
### Cross-Cluster Components
|
|
82
|
+
|
|
83
|
+
<!-- Components that serve multiple clusters -->
|
|
84
|
+
|
|
85
|
+
| Component | Directory | Primary Cluster | Notes |
|
|
86
|
+
|-----------|-----------|----------------|-------|
|
|
87
|
+
| [Name] | [path/] | [VERB] | [Why it's cross-cluster] |
|
|
88
|
+
|
|
89
|
+
### Backend-Only Integrations (No Frontend UI)
|
|
90
|
+
|
|
91
|
+
<!-- Services with no corresponding UI components. Explain why. -->
|
|
92
|
+
|
|
93
|
+
[List and explain.]
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## 5. File Importance Ranking
|
|
98
|
+
|
|
99
|
+
### Tier 1 — Critical (System won't function without these)
|
|
100
|
+
|
|
101
|
+
| Rank | File | Why |
|
|
102
|
+
|------|------|-----|
|
|
103
|
+
| 1 | [path/to/file] | [One-line justification] |
|
|
104
|
+
<!-- 10 files typical -->
|
|
105
|
+
|
|
106
|
+
### Tier 2 — Important (Core features break without these)
|
|
107
|
+
|
|
108
|
+
| Rank | File | Why |
|
|
109
|
+
|------|------|-----|
|
|
110
|
+
| 11 | [path/to/file] | [One-line justification] |
|
|
111
|
+
<!-- 10 files typical -->
|
|
112
|
+
|
|
113
|
+
### Tier 3 — Supporting (Degrade gracefully without these)
|
|
114
|
+
|
|
115
|
+
| Rank | File | Why |
|
|
116
|
+
|------|------|-----|
|
|
117
|
+
| 21-25 | [path/to/files] | [Category description] |
|
|
118
|
+
<!-- Group by category, 20-30 files typical -->
|
|
119
|
+
|
|
120
|
+
### Tier 4 — Knowledge (Essential for development, not runtime)
|
|
121
|
+
|
|
122
|
+
| Rank | File | Why |
|
|
123
|
+
|------|------|-----|
|
|
124
|
+
| 51 | [path/to/file] | [One-line justification] |
|
|
125
|
+
<!-- Variable count -->
|
|
126
|
+
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## 6. Health Assessment
|
|
130
|
+
|
|
131
|
+
<!-- Per the health-audit framework -->
|
|
132
|
+
|
|
133
|
+
### Critical Issues
|
|
134
|
+
<!-- Build failures, critical vulnerabilities, broken main branch -->
|
|
135
|
+
- **[None / List issues]**
|
|
136
|
+
|
|
137
|
+
### Security
|
|
138
|
+
|
|
139
|
+
| Area | Status | Notes |
|
|
140
|
+
|------|--------|-------|
|
|
141
|
+
| Secret management | [emoji] | [Assessment] |
|
|
142
|
+
| Authentication | [emoji] | [Assessment] |
|
|
143
|
+
| Authorization/RLS | [emoji] | [Assessment] |
|
|
144
|
+
| Encryption | [emoji] | [Assessment] |
|
|
145
|
+
|
|
146
|
+
### Sustainability
|
|
147
|
+
|
|
148
|
+
| Area | Status | Notes |
|
|
149
|
+
|------|--------|-------|
|
|
150
|
+
| Backend test coverage | [emoji] | [Percentage + assessment] |
|
|
151
|
+
| Frontend test coverage | [emoji] | [Percentage + assessment] |
|
|
152
|
+
| CI/CD automation | [emoji] | [Workflow count + assessment] |
|
|
153
|
+
| Technical debt | [emoji] | [Assessment] |
|
|
154
|
+
| Documentation | [emoji] | [File count + assessment] |
|
|
155
|
+
| Manual processes | [emoji] | [List any] |
|
|
156
|
+
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
## 7. Active Workstreams
|
|
160
|
+
|
|
161
|
+
<!-- What's being worked on right now -->
|
|
162
|
+
|
|
163
|
+
| Workstream | Owner/Agent | Status | Focus |
|
|
164
|
+
|------------|-------------|--------|-------|
|
|
165
|
+
| [Name] | [Who] | [emoji] | [What they're doing] |
|
|
166
|
+
|
|
167
|
+
---
|
|
168
|
+
|
|
169
|
+
## 8. Blockers & Dependencies
|
|
170
|
+
|
|
171
|
+
<!-- Be ruthlessly honest. If nothing, say "None." -->
|
|
172
|
+
|
|
173
|
+
- **[Blocker description]** — [Impact and who owns resolution]
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
## 9. Next Steps
|
|
178
|
+
|
|
179
|
+
1. [emoji] [Concrete, actionable task]
|
|
180
|
+
2. [emoji] [Concrete, actionable task]
|
|
181
|
+
3. [emoji] [Concrete, actionable task]
|
|
182
|
+
|
|
183
|
+
---
|
|
184
|
+
|
|
185
|
+
## 10. Aggregate Statistics
|
|
186
|
+
|
|
187
|
+
| Metric | Value |
|
|
188
|
+
|--------|-------|
|
|
189
|
+
| Total [primary language] LOC | ~[number] |
|
|
190
|
+
| Total [primary language] files | [number] |
|
|
191
|
+
| Total [secondary language] LOC | ~[number] |
|
|
192
|
+
| Total [secondary language] files | [number] |
|
|
193
|
+
| Total [tools/features/endpoints] | [number] |
|
|
194
|
+
| Total documentation files | [number] |
|
|
195
|
+
| Total migrations | [number] |
|
|
196
|
+
| Total CI/CD workflows | [number] |
|
|
197
|
+
| Versions shipped | [number] |
|
|
198
|
+
<!-- Add project-specific metrics -->
|
|
199
|
+
|
|
200
|
+
---
|
|
201
|
+
|
|
202
|
+
[optional signature/emoji]
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
---
|
|
206
|
+
|
|
207
|
+
## Template Usage Notes
|
|
208
|
+
|
|
209
|
+
1. **Delete all HTML comments** (`<!-- -->`) before saving the final document.
|
|
210
|
+
2. **Adapt the section count.** Small projects may combine sections 7-9 or skip section 5.
|
|
211
|
+
3. **Emoji consistency matters.** Use the status key from section 2 everywhere.
|
|
212
|
+
4. **LOC is approximate.** Use `~` prefix for estimates. Exact to within 10% is fine.
|
|
213
|
+
5. **The tree in section 3 should be complete but not exhaustive.** Show 2-3 levels deep for most directories. Go deeper only for architecturally significant subtrees.
|
|
214
|
+
6. **Section 4 (clusters) is the most variable.** A simple app might have 4-5 clusters. A complex platform might have 13+. Let the project's actual capabilities determine the count.
|