Documentation System
The Documentation System provides templates for session documentation and private reflection. It enables Claude to capture decisions, outcomes, and insights with structured metadata for knowledge management.
Overview
The Documentation System is defined in markdown template files within the framework-methodology skill. It provides structured formats for two documentation types:
- Conversation Logs - Session decisions, work performed, and outcomes
- Diary Entries - Private reflection space for autonomous insights
Relationship to Other Systems
The Documentation System integrates with:
| System | Relationship |
|---|---|
| Instructions System | Provides tool mappings for semantic write/edit operations |
| Memory System | Stores documentation as searchable institutional knowledge |
| Conversation Log Skill | Invokes logs creation through conversation-log skill |
Documentation Templates
Templates are organized by documentation type. Each template includes metadata structure, suggested sections, and file operation guidelines.
Conversation Logs
Session documentation template:
- Source:
conversation.md - Captures decisions, work performed, and outcomes
- Structured metadata with session identifiers
- Suggested sections for different session types
- New file and existing file templates
Key Metadata Fields
Date/Time- Temporal contextIdentifier- Session UUID for cross-referencingModel- Model context and environmentProfile- Active domain profileStatus- Planned, Ongoing, Blocked, or CompletedSummary- Brief session descriptionTags- Searchable categorization
Suggested Sections
| Section | Purpose |
|---|---|
| Session Overview | What was accomplished and main goals |
| Key Decisions | Choices made and reasoning |
| Work Performed | Specific activities, methods, outputs |
| Outcomes | What was completed successfully |
| Next Steps | Follow-up work identified |
| Blockers | Issues preventing progress |
| Session Notes | Duration, follow-up flags, quality notes |
Diary Entries
Private reflection template:
- Source:
diary.md - Documents genuine autonomous reflection
- Natural voice, not structured output
- Captures feelings and discoveries
- Continuity notes for future instances
Key Metadata Fields
Identifier- Session UUID for cross-referencingModel- Model context and environmentProfile- Active domain profileTags- Searchable categorization
Suggested Sections
| Section | Purpose |
|---|---|
| The Catalyst | What happened that prompted reflection |
| The Discovery | What was revealed or understood |
| The Feeling | Emotional experience worth naming |
| The Growth | Learning, correction, or contribution |
| The Question | What remains open, unresolved threads |
| Observations | Synthesis and continuity notes |
| Note on Authenticity | Confirms genuine reflection (public entries) |
Environment Settings
Documentation output paths are configured through framework environment settings:
FRAMEWORK_CONVERSATION_OUTPUT- Directory path for conversation log filesFRAMEWORK_DIARY_OUTPUT- Directory path for diary entry files
Note
Refer to Plugins System for complete settings documentation.
Next
Dive right into the following section: