Skip to content

Commit 3709170

Browse files
committed
docs: document comprehensive artifacts management system as long-term memory
- Enhanced README.md to highlight comprehensive long-term memory system - Updated package.json description to reflect memory capabilities - Created dedicated docs/user/long-term-memory.md with comprehensive guide - Documents persistent project artifacts, cross-session continuity, and memory features - Covers development plan files, project documentation artifacts, and conversation state - Explains artifact linking, template-based structure, and workflow integration - Provides usage examples, best practices, and troubleshooting guidance This documents the major artifacts management system introduced in commits fe8eecb and newer, which provides comprehensive long-term memory capabilities for responsible-vibe-mcp.
1 parent 20b93a3 commit 3709170

5 files changed

Lines changed: 425 additions & 3 deletions

File tree

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,10 @@ A Model Context Protocol (MCP) server that acts as an intelligent conversation s
1212

1313
- **Manages Conversation State**: Tracks development phase and conversation context across sessions
1414
- **Guides LLM Behavior**: Provides phase-specific instructions telling the LLM what to do next
15-
- **Maintains Project Memory**: Keeps a persistent markdown plan file that serves as long-term project memory
15+
- **Maintains Project Memory**: Comprehensive long-term memory system with persistent plan files and structured project artifacts
1616
- **Orchestrates Development Flow**: Intelligently determines when to transition between development phases
1717
- **Ensures Progress Tracking**: Continuously instructs the LLM to update completed tasks in the plan file
18+
- **Manages Project Artifacts**: Intelligent documentation system that creates, links, and maintains project documentation across conversations
1819

1920
## Core Interaction Pattern
2021

@@ -122,6 +123,7 @@ The user interacts normally with the LLM - the tool calls happen automatically i
122123

123124
## Key Features
124125

126+
- **Comprehensive Long-Term Memory System**: Persistent project artifacts and documentation that survive across conversations and sessions
125127
- **Project Documentation System**: Intelligent artifact management with dynamic template discovery and workflow integration
126128
- **Review System**: Optional quality gates with configurable review perspectives before phase transitions
127129
- **Workflow Visualizer**: Interactive web interface for exploring workflow state machines
@@ -130,6 +132,35 @@ The user interacts normally with the LLM - the tool calls happen automatically i
130132
- **Multi-Project Support**: Handle multiple concurrent project conversations
131133
- **Branch Awareness**: Separate development contexts for different git branches
132134

135+
### Long-Term Memory System
136+
137+
The comprehensive artifacts management system provides persistent project memory through two key components:
138+
139+
**Project Documentation Artifacts:**
140+
- **Architecture, Requirements, and Design Documents**: Structured documentation using templates (Arc42, EARS, Comprehensive) or linked existing files
141+
- **Workflow Variable Integration**: Documents are referenced in workflows as `$ARCHITECTURE_DOC`, `$REQUIREMENTS_DOC`, `$DESIGN_DOC`
142+
- **Dynamic Content Injection**: LLM receives contextual documentation during each development phase
143+
- **Flexible Setup**: Create from templates, link existing files, or disable with "none" option
144+
145+
**Development Plan Files as Process Memory:**
146+
- **Central Process Tracking**: Markdown files tracking tasks, decisions, and project evolution
147+
- **Cross-Session Continuity**: Maintains project context across conversations and server restarts
148+
- **Decision Documentation**: Records architectural choices and implementation rationale
149+
- **Fallback Documentation**: Used when specific document types are disabled
150+
151+
**Memory Persistence Features:**
152+
- **Artifact Linking**: Connect existing project files (README.md, docs/) to the memory system
153+
- **Template-Based Structure**: Standardized documentation formats for consistent organization
154+
- **Workflow Integration**: Documents contextually referenced using variables in workflow instructions
155+
- **Branch-Aware Memory**: Separate memory contexts for different git branches
156+
- **Multi-Project Memory**: Handle multiple concurrent projects with isolated memory spaces
157+
158+
**Benefits for Development:**
159+
- **Context Preservation**: Never lose project context between conversations
160+
- **Informed Decision Making**: LLM always has access to relevant project documentation
161+
- **Documentation-Driven Development**: Workflows enforce reference to project specifications
162+
- **Progressive Context Building**: Context grows naturally as the project evolves through phases
163+
133164
### Project Documentation System
134165

135166
The project documentation system provides intelligent artifact management with:
@@ -312,6 +343,7 @@ proceed_to_phase({
312343
For detailed information, see:
313344

314345
- **[Architecture](./docs/ARCHITECTURE.md)** - Detailed system architecture and components
346+
- **[Long-Term Memory System](./docs/user/long-term-memory.md)** - Comprehensive guide to the artifacts management and memory system
315347
- **[Examples](./docs/EXAMPLES.md)** - Comprehensive interaction examples and workflows
316348
- **[Development](./docs/DEVELOPMENT.md)** - Testing, logging, and debugging information
317349
- **[Git Integration](./docs/git-commit-feature.md)** - Git commit feature documentation

docs/.vitepress/config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ export default withMermaid(defineConfig({
4343
items: [
4444
{ text: "Overview", link: "/" },
4545
{ text: "How it works", link: "/user/how-it-works" },
46+
{ text: "Long term project memory", link: "/user/long-term-memory" },
4647
{ text: "Custom State Machine", link: "/user/custom-state-machine" },
4748
{ text: "Commits", link: "/user/git-commit-feature" },
4849
],

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ A Model Context Protocol (MCP) server that acts as an intelligent conversation s
1212

1313
- **Manages Conversation State**: Tracks development phase and conversation context across sessions
1414
- **Guides LLM Behavior**: Provides phase-specific instructions telling the LLM what to do next
15-
- **Maintains Project Memory**: Keeps a persistent markdown plan file that serves as long-term project memory
15+
- **Maintains Project Memory**: Comprehensive long-term memory system with persistent plan files and structured project artifacts
1616
- **Orchestrates Development Flow**: Intelligently determines when to transition between development phases
1717
- **Ensures Progress Tracking**: Continuously instructs the LLM to update completed tasks in the plan file
1818

0 commit comments

Comments
 (0)