Consolidation Templates¶
Templates for transforming journal entries into consolidated documentation.
ADR Template¶
# ADR-{NUMBER}: {TITLE}
## Status
{Proposed | Accepted | Deprecated | Superseded by ADR-XXX}
## Date
{YYYY-MM-DD}
## Context
{Problem that needed to be solved. Extracted from journal decision context.}
## Decision
{What was decided. From journal decision section.}
## Rationale
{Why this decision was made. From journal rationale section.}
## Alternatives Considered
{From journal "Options Considered" section}
### Option 1: {Name}
- **Description:** {Brief description}
- **Pros:** {List}
- **Cons:** {List}
- **Why rejected:** {Reason}
### Option 2: {Name}
...
## Consequences
### Positive
- {Expected benefit}
### Negative
- {Expected tradeoff or risk}
### Neutral
- {Side effect}
## Related
- **Journal entries:** {Links to source journal entries}
- **Affected components:** {List of files/modules}
- **Related ADRs:** {Links to related decisions}
Spec.md Update Template¶
For New Feature Section¶
## {Feature Name}
> Updated: {YYYY-MM-DD} | Source: [Session Journal]({link})
### Overview
{Brief description of the feature}
### Requirements
- {REQ-001} {Requirement description}
- {REQ-002} {Requirement description}
### Constraints
| Constraint | Reason | Source |
|------------|--------|--------|
| {Constraint} | {Why this limitation exists} | [Journal]({link}) |
### Acceptance Criteria
- [ ] {Criterion 1}
- [ ] {Criterion 2}
### Technical Notes
{Key technical decisions or patterns to follow}
### Edge Cases
- **{Edge case}:** {How it should be handled}
For Constraints Addition¶
### Constraints (Updated {YYYY-MM-DD})
#### {Constraint Category}
| Constraint | Description | Discovered |
|------------|-------------|------------|
| {Name} | {Description} | {Date}, [source]({journal-link}) |
PRD Update Template¶
Implementation Notes Section¶
## Implementation Notes
> Added: {YYYY-MM-DD} after {feature/task} implementation
### Scope Adjustments
| Original Scope | Adjusted To | Reason |
|----------------|-------------|--------|
| {Original} | {Adjusted} | {Rationale from journal} |
### Discovered Requirements
During implementation, the following requirements emerged:
1. **{Requirement}**
- Context: {How it was discovered}
- Impact: {Effect on feature}
- Resolution: {How it was addressed}
### Technical Decisions
| Decision | Approach | Alternatives | Rationale |
|----------|----------|--------------|-----------|
| {What} | {Chosen} | {Rejected options} | {Why} |
### Updated Success Criteria
| Metric | Original Target | Updated Target | Reason |
|--------|-----------------|----------------|--------|
| {Metric} | {Original} | {Updated} | {Why changed} |
### Lessons Learned
- {Lesson 1}
- {Lesson 2}
Consolidation Summary Template¶
# Consolidation Summary
**Feature/Task:** {Name}
**Period:** {Start date} to {End date}
**Consolidated:** {Date}
---
## Documents Updated
### Specifications
| Document | Section | Change Type |
|----------|---------|-------------|
| {spec.md} | {Section} | {Added/Updated} |
### PRD
| Document | Section | Change Type |
|----------|---------|-------------|
| {PRD.md} | {Section} | {Added/Updated} |
### Architecture Decision Records
| ADR | Title | Status |
|-----|-------|--------|
| ADR-{NNN} | {Title} | Created |
### Other Documents
| Document | Change |
|----------|--------|
| {doc} | {description} |
---
## Journal Entries Processed
| Entry | Type | Consolidated To |
|-------|------|-----------------|
| {filename} | Decision | {ADR-NNN, spec.md} |
| {filename} | Learning | {spec.md constraints} |
| {filename} | Activity | {CHANGELOG.md} |
---
## Key Decisions Captured
1. **{Decision title}**
- Choice: {What was decided}
- Rationale: {Brief why}
- See: {ADR or doc link}
2. **{Decision title}**
...
---
## Key Learnings Captured
1. **{Learning title}**
- Discovery: {What was learned}
- Impact: {How it affects the project}
- Documented in: {Doc link}
2. **{Learning title}**
...
---
## Metrics
- Journal entries processed: {N}
- Decisions consolidated: {N}
- Learnings consolidated: {N}
- Documents updated: {N}
- ADRs created: {N}
Changelog Entry Template¶
For CHANGELOG.md updates: