Skip to content

Commit 56a3ffd

Browse files
committed
fixes for tempaltes
1 parent 0d27e7c commit 56a3ffd

7 files changed

Lines changed: 31 additions & 18 deletions

File tree

docs/templates/ADR-Template.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# ADR-XXXX: Title
22

3+
> TEMPLATE ONLY — remove this note and replace all placeholder text before saving as a real ADR under `docs/ADR/`.
4+
35
Status: Proposed | Accepted | Implemented | Rejected | Superseded
46
Date: YYYY-MM-DD
57
Related Features: `docs/Features/...` (recommended)
@@ -46,11 +48,11 @@ Key points:
4648

4749
---
4850

49-
## Diagram (Mandatory)
51+
## Diagram
52+
53+
This section is mandatory.
5054

5155
```mermaid
52-
%% Show the boundaries/modules that change, and how they interact.
53-
%% Prefer 1 clear diagram over many noisy ones.
5456
```
5557

5658
---
@@ -108,7 +110,9 @@ Key points:
108110

109111
---
110112

111-
## Verification (Mandatory: describe how to test this decision)
113+
## Verification
114+
115+
This section is mandatory: describe how to prove the decision (tests + commands).
112116

113117
### Objectives
114118

@@ -127,7 +131,7 @@ Key points:
127131
- build: (paste from `AGENTS.md`)
128132
- test: (paste from `AGENTS.md`)
129133
- format: (paste from `AGENTS.md`)
130-
- coverage: (paste from `AGENTS.md` if separate)
134+
- coverage: (paste from `AGENTS.md`; delete if none)
131135

132136
### New or changed tests
133137

docs/templates/AGENTS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,10 @@ If no new rule is detected → do not update the file.
9393

9494
- All docs live in `docs/` (or `.wiki/`)
9595
- Global architecture entry point: `docs/Architecture/Overview.md` (read first)
96+
- When creating docs from `docs/templates/*`:
97+
- copy the template, then remove every `TEMPLATE ONLY` note
98+
- replace all placeholder text (`TODO:`, `...`, “FeatureName”, “ADR-XXXX”, etc.)
99+
- real docs must not contain template instructions or placeholder scaffolding
96100
- Update feature docs when behaviour changes
97101
- Update ADRs when architecture changes
98102
- Diagrams are mandatory in docs:

docs/templates/Architecture-Template.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
# Architecture Overview (Template)
1+
# Architecture Overview
22

3-
> Save this as: `docs/Architecture/Overview.md`
4-
> Goal: in ~5 minutes, understand **what exists**, **where it lives**, and **how modules interact**.
3+
> TEMPLATE ONLY — remove this note and replace all placeholder text before saving as a real `docs/Architecture/Overview.md`.
54
6-
## 1) TL;DR (fill this, keep it short)
5+
Goal: in ~5 minutes, understand **what exists**, **where it lives**, and **how modules interact**.
6+
7+
## Summary (keep it short)
78

89
- **System:**
910
- **Where is the code:**
@@ -12,20 +13,16 @@
1213

1314
## 2) Module map (Mermaid)
1415

16+
> TEMPLATE ONLY — model modules + boundaries (not every class/file). Add dependencies only if they exist. Remove this note in the real doc.
17+
1518
```mermaid
1619
flowchart LR
17-
%% Model MODULES + BOUNDARIES, not every class/file.
18-
%% Replace nodes with your real modules (or services) and label arrows.
19-
2020
EP[Entry Points]
2121
A[Module A]
2222
B[Module B]
2323
2424
EP --> A
2525
A --> B
26-
%% Add dependencies only if they exist:
27-
%% A --> D[(Data Store)]
28-
%% A --> X[External Service]
2926
```
3027

3128
## 3) Modules (catalog)

docs/templates/Feature-Template.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Feature: FeatureName
22

3+
> TEMPLATE ONLY — remove this note and replace all placeholder text before saving as a real feature doc under `docs/Features/`.
4+
35
Links:
46
Architecture: `docs/Architecture/Overview.md`
57
Modules:
@@ -78,12 +80,13 @@ Short description of the business problem and value.
7880
## Diagrams
7981

8082
```mermaid
81-
%% Mermaid diagram for the main flow (modules + interactions).
8283
```
8384

8485
---
8586

86-
## Verification (Mandatory: describe how to test)
87+
## Verification
88+
89+
This section is mandatory: describe how to test (scenarios + commands).
8790

8891
### Test environment
8992

@@ -126,7 +129,9 @@ Short description of the business problem and value.
126129
- Unit tests:
127130
- Static analysis:
128131

129-
### Non-functional checks (delete section if not applicable)
132+
### Non-functional checks
133+
134+
Include this section only if it applies to this feature; otherwise remove it.
130135

131136
- Performance / load (tool, threshold, command):
132137
- Security / privacy (threats to verify):

skills/mcaf-adr-writing/SKILL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Before writing, make the ADR executable (no placeholders, no hand-waving):
2828
- what changes (and what does not)
2929
- what module(s) are affected
3030
2. Start from `docs/templates/ADR-Template.md`.
31+
- Remove every `TEMPLATE ONLY` note and replace placeholder text before treating it as a real ADR.
3132
3. Write the ADR as a decision record:
3233
- **Context**: constraints + why this is needed now
3334
- **Decision**: a short, direct statement

skills/mcaf-architecture-overview/SKILL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ This doc is the **global map**: boundaries, modules, and dependency rules.
2525
## Workflow
2626

2727
1. Open `docs/Architecture/Overview.md` if it exists; otherwise start from `docs/templates/Architecture-Template.md`.
28+
- Remove every `TEMPLATE ONLY` note and replace placeholder text before treating it as a real doc.
2829
2. Identify the **real** top-level boundaries:
2930
- entry points (HTTP/API, CLI, UI, jobs, events)
3031
- modules/layers (group by folders/namespaces, not individual files)

skills/mcaf-feature-spec/SKILL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Write a spec that can be implemented and verified **without guessing**:
2626

2727
1. Start from `docs/Architecture/Overview.md` to pick the affected module(s).
2828
2. Create/update the feature doc using `docs/templates/Feature-Template.md`.
29+
- Remove every `TEMPLATE ONLY` note and replace placeholder text before treating it as a real spec.
2930
3. Define behaviour precisely:
3031
- purpose and scope (in/out)
3132
- business rules (numbered, testable)

0 commit comments

Comments
 (0)