Initial project scaffolding
This commit is contained in:
158
templates/claude-templates.md
Normal file
158
templates/claude-templates.md
Normal file
@@ -0,0 +1,158 @@
|
||||
# Claude Templates — On-Demand Reference
|
||||
|
||||
> **Do NOT read this file at session start.** Read it only when you need to write a summary, handoff, decision record, or subagent output. This file is referenced from CLAUDE.md.
|
||||
|
||||
---
|
||||
|
||||
## Template 1: Source Document Summary
|
||||
|
||||
**Use when:** Processing any input document (client brief, research report, requirements doc, existing proposal)
|
||||
|
||||
**Write to:** `./docs/summaries/source-[filename].md`
|
||||
|
||||
```markdown
|
||||
# Source Summary: [Original Document Name]
|
||||
**Processed:** [YYYY-MM-DD]
|
||||
**Source Path:** [exact file path]
|
||||
**Archived From:** [original path, if moved to docs/archive/]
|
||||
**Document Type:** [brief / requirements / research / proposal / transcript / other]
|
||||
**Confidence:** [high = I understood everything / medium = some interpretation needed / low = significant gaps]
|
||||
|
||||
## Exact Numbers & Metrics
|
||||
- [metric]: [exact value] (page/section reference if available)
|
||||
|
||||
## Key Facts (Confirmed)
|
||||
- [fact] — stated in [section/page]
|
||||
|
||||
## Requirements & Constraints
|
||||
- REQUIREMENT: [what is needed]
|
||||
- CONDITION: [when/if this applies]
|
||||
- CONSTRAINT: [limitation or exception]
|
||||
- PRIORITY: [must-have / should-have / nice-to-have / stated by whom]
|
||||
|
||||
## Decisions Referenced
|
||||
- DECISION: [what was decided]
|
||||
- RATIONALE: [why, as stated in document]
|
||||
- ALTERNATIVES MENTIONED: [what else was considered]
|
||||
- DECIDED BY: [who, if stated]
|
||||
|
||||
## Open Questions & Ambiguities
|
||||
- UNCLEAR: [what is ambiguous] — needs clarification from [whom]
|
||||
- ASSUMED: [interpretation made] — verify with [whom]
|
||||
- MISSING: [information referenced but not provided]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Template 4: Session Handoff
|
||||
|
||||
**Use when:** A session is ending (context limit approaching OR phase complete)
|
||||
|
||||
**Write to:** `./docs/summaries/handoff-[YYYY-MM-DD]-[topic].md`
|
||||
|
||||
**LIFECYCLE**: After writing a new handoff, move the PREVIOUS handoff to `docs/archive/handoffs/`.
|
||||
|
||||
```markdown
|
||||
# Session Handoff: [Topic]
|
||||
**Date:** [YYYY-MM-DD]
|
||||
**Session Duration:** [approximate]
|
||||
**Session Focus:** [one sentence]
|
||||
**Context Usage at Handoff:** [estimated percentage if known]
|
||||
|
||||
## What Was Accomplished
|
||||
1. [task completed] → output at `[file path]`
|
||||
|
||||
## Exact State of Work in Progress
|
||||
- [work item]: completed through [specific point], next step is [specific action]
|
||||
|
||||
## Decisions Made This Session
|
||||
- [Ad-hoc decision]: [what] BECAUSE [why] — STATUS: [confirmed/provisional]
|
||||
|
||||
## Key Numbers Generated or Discovered This Session
|
||||
- [metric]: [value]
|
||||
|
||||
## Files Created or Modified
|
||||
| File Path | Action | Description |
|
||||
|-----------|--------|-------------|
|
||||
| `[path]` | Created | [what it contains] |
|
||||
|
||||
## What the NEXT Session Should Do
|
||||
1. **First**: [specific action with file paths]
|
||||
2. **Then**: [specific action]
|
||||
|
||||
## Open Questions Requiring User Input
|
||||
- [ ] [question] — impacts [what downstream deliverable]
|
||||
|
||||
## Assumptions That Need Validation
|
||||
- ASSUMED: [assumption] — validate by [method/person]
|
||||
|
||||
## Files to Load Next Session
|
||||
- `[file path]` — needed for [reason]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Template 3: Decision Record
|
||||
|
||||
**Use when:** Any significant decision is made during a session
|
||||
|
||||
**Write to:** `./docs/summaries/decision-[number]-[topic].md`
|
||||
|
||||
```markdown
|
||||
# Decision Record: [Short Title]
|
||||
**Decision ID:** DR-[sequential number]
|
||||
**Date:** [YYYY-MM-DD]
|
||||
**Status:** CONFIRMED / PROVISIONAL / REQUIRES_VALIDATION
|
||||
|
||||
## Decision
|
||||
[One clear sentence: what was decided]
|
||||
|
||||
## Context
|
||||
[2-3 sentences: what situation prompted this decision]
|
||||
|
||||
## Rationale
|
||||
- CHOSE [option] BECAUSE: [specific reasons with data]
|
||||
- REJECTED [alternative 1] BECAUSE: [specific reasons]
|
||||
|
||||
## Conditions & Constraints
|
||||
- VALID IF: [conditions under which this decision holds]
|
||||
- REVISIT IF: [triggers that should cause reconsideration]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Subagent Output Contracts
|
||||
|
||||
### Contract for Document Analysis Subagent
|
||||
|
||||
```
|
||||
=== DOCUMENT ANALYSIS OUTPUT ===
|
||||
SOURCE: [file path]
|
||||
TYPE: [document type]
|
||||
CONFIDENCE: [high/medium/low]
|
||||
|
||||
NUMBERS:
|
||||
- [metric]: [exact value]
|
||||
|
||||
REQUIREMENTS:
|
||||
- REQ: [requirement] | CONDITION: [if any] | PRIORITY: [level]
|
||||
|
||||
OPEN:
|
||||
- [unresolved item] | NEEDS: [who/what to resolve]
|
||||
|
||||
=== END OUTPUT ===
|
||||
```
|
||||
|
||||
### Contract for Review/QA Subagent
|
||||
|
||||
```
|
||||
=== REVIEW OUTPUT ===
|
||||
REVIEWED: [file path or deliverable name]
|
||||
AGAINST: [what standard]
|
||||
PASS: [yes/no/partial]
|
||||
|
||||
ISSUES:
|
||||
- SEVERITY: [critical/major/minor] | ITEM: [description] | FIX: [suggested resolution]
|
||||
|
||||
=== END OUTPUT ===
|
||||
```
|
||||
Reference in New Issue
Block a user