Repository navigation
RDD v1.1.0
Release Notes - RDD Framework v1.1.0
Release Date: November 15, 2025
Overview
Version 1.1.0 introduces significant improvements to the RDD Framework, focusing on configuration management, documentation consolidation, and enhanced user guidance. This release includes 11 major improvements spanning new features, bug fixes, and comprehensive documentation updates.
Key Features
Configuration Management
- Interactive Configuration Menu: New menu option (5) provides easy access to configuration management
- Version Management: Increment major, minor, or patch version numbers directly from the menu
- Branch Selection: Interactive selection of default branch from available Git branches
- Local-Only Toggle: Easy toggle for local-only mode flag
- Automatic Timestamp Updates: Configuration changes automatically update the lastModified timestamp
User Story Planning
- User Story Template System: New template file (
.rdd/templates/user-story.md) with standard structure - Automatic Lifecycle Management: User stories are automatically created, backed up, and reset during iteration workflow
- State-Based Analysis: New state-based workflow (9 states) for systematic requirement gathering and clarification
- Requirements Questionnaire: Automatic generation of detailed questions based on clarity checklist
Enhanced Documentation
- Complete User Guide Rewrite: Comprehensive 500+ line user guide with simplified, self-service oriented content
- PDF Distribution: User guide now available in PDF format for offline/print use
- Documentation Consolidation: Merged data-model.md and folder-structure.md into tech-spec.md for single source of truth
- Work Iteration Prompts: Relocated to
.rdd-docs/work-iteration-prompts.mdfor better organization
Improvements
Build and Installation
- User Guide in Release: Fixed build script to include user-guide.md in release archives
- Prompt Cleanup: Enhanced installer removes obsolete RDD prompt files before installing new ones
- PDF Installation: User guide PDF automatically installed to
.rdd/directory
Menu Structure
- Expanded Main Menu: New 9-option menu structure with reserved slots for future features
- Create new iteration
- Update from default
- Complete current iteration
- Delete merged branches
- Configuration (NEW)
6-8. Reserved for future expansion - Exit
File Organization
- Simplified Documentation Structure: Consolidated technical documentation eliminates redundant files
- Updated References: All documentation references updated to point to correct file locations
Bug Fixes
- User Guide Missing from Release: Fixed build.py to include user-guide.md in release archives
- Prompt File Cleanup: Installer now removes obsolete prompt files before installation to prevent conflicts
- Documentation Accuracy: Removed outdated references to non-existent folders and files from tech-spec.md
- Test Fixes: Updated test assertions to reflect P04 documentation consolidation changes
New Requirements Added
This release adds 22 new functional requirements (FR-98 through FR-122):
- FR-98: Consolidated Technical Documentation
- FR-99: Prompt Cleanup During Installation
- FR-100: Work Iteration Prompts Backup and Reset
- FR-101: User Story File Management
- FR-102: Interactive Configuration Menu
- FR-103: Configuration Menu Placement
- FR-104: Version Increment Options
- FR-105: Interactive Branch Selection
- FR-106: Local-Only Toggle
- FR-107: User Story State Tracking
- FR-108: State-Based Prompt Behavior
- FR-109: State Validation
- FR-110: Single State Enforcement
- FR-111: Main Questions Collection
- FR-112: Questionnaire Generation
- FR-113: Questionnaire Answer Tracking
- FR-114: Completeness Confirmation
- FR-115: Execution Plan Generation
- FR-116: Plan Detail Confirmation
- FR-117: Plan Revision Support
- FR-118: Cross-Reference Existing Documentation
- FR-119: Question Format Compliance
- FR-120: Data Preservation During Re-execution
- FR-121: Clear Next Steps Guidance
- FR-122: User Guide PDF Distribution
Files Changed
- New Files Created: 6 (including config-management.py, user-story.md template)
- Files Modified: 25+ (including rdd.py, install.py, build.py, documentation files)
- Files Deleted: 4 (data-model.md, folder-structure.md - content consolidated into tech-spec.md)
- Files Renamed: 1 (copilot-prompts.md → work-iteration-prompts.md)
Testing
All 87 tests passing:
- 49 Python unit tests
- 14 build tests
- 24 installation tests
Test suite updated to reflect all changes including:
- Configuration management functionality
- Documentation consolidation
- User story lifecycle management
- Updated file locations
Upgrade Notes
When upgrading from v1.0.x to v1.1.0:
- The main menu now has 9 options instead of 5 - note the new Configuration option at position 5
- Documentation files
data-model.mdandfolder-structure.mdhave been consolidated intotech-spec.md - Work iteration prompts file is now at
.rdd-docs/work-iteration-prompts.md(no longer in workspace subfolder) - User guide is now available in both Markdown and PDF formats
- Configuration can now be managed interactively through the menu
For complete technical details, see .rdd-docs/requirements.md and .rdd-docs/tech-spec.md.