Release Notes Template
Use this template for comprehensive release documentation.
[Tool Name] vX.X.X
Release Date: YYYY-MM-DD
Summary
[One paragraph summary of this release - what's new, what changed, and why it matters]
Highlights
- [Key highlight 1]
- [Key highlight 2]
- [Key highlight 3]
Architecture
System Design
[Describe the overall architecture, processing flow, and key components]
Data Flow
[Input] → [Step 1] → [Step 2] → [Output]
Key Files
| File | Purpose |
|------|---------|
| path/to/file.ts | Description |
Model Configuration
| Phase | Model | Reasoning | |-------|-------|-----------| | Phase 1 | model-name | Why this model |
Prompt Details
[Phase/Component Name]
Purpose: [What this prompt accomplishes]
Model: model-name
[Full prompt text]
Key Rules:
- Rule 1
- Rule 2
Schema Definitions
[Schema Name]
const schema = z.object({
// Schema definition
});
Changes from Previous Version
Added
- [New feature or capability]
Changed
- [Modified behavior]
Fixed
- [Bug fix]
Removed
- [Deprecated or removed feature]
Migration Guide
[If breaking changes, explain how to migrate]
Known Limitations
- [Limitation 1]
- [Limitation 2]
Related ADRs
Performance Characteristics
| Metric | Value | Notes | |--------|-------|-------| | Average processing time | Xms | Under normal load | | Token usage (avg) | X tokens | Per request |
Appendix
Full Configuration Reference
[Additional technical details as needed]