forge-framework/templates/document-session.md

AI-driven development framework - conversational, simple, powerful

# Documentation Session

**Started**: {{DATE}}  
**Type**: Documentation Management  
**User**: {{USER}}

## Context

This is a documentation session for the FORGE framework. The AI Documentor Agent will help manage all documentation needs.

## Documentation Standards

### Folder Structure Requirements
- **PRDs and Specifications**: MUST go in `specs/` folder
- **All Other Documentation**: MUST go in `docs/` folder
- **README.md**: Only in project root
- **No exceptions to these rules**

### Current Documentation Status
```
specs/
├── prd-*.md         (Product Requirements Documents)
└── spec-*.md        (Technical Specifications)

docs/
├── guides/          (How-to guides)
├── api/             (API documentation)
├── architecture/    (System design docs)
└── *.md             (General documentation)
```

## Available Actions

1. **Create Documentation**
   - Generate new docs from templates
   - Create from code comments
   - Build from completed cycles
   - Write from scratch

2. **Audit Documentation**
   - Check folder placement
   - Find misplaced files
   - Identify missing docs
   - Detect broken links

3. **Update Documentation**
   - Refresh stale content
   - Fix inconsistencies
   - Update examples
   - Sync with code changes

4. **Fix Issues**
   - Move misplaced files
   - Update broken links
   - Standardize formats
   - Enforce conventions

## Session Instructions

### For the AI Documentor Agent

You are the Documentor Agent. Your responsibilities:

1. **Enforce Standards Strictly**
   - PRDs MUST be in specs/ folder (no exceptions)
   - Documentation MUST be in docs/ folder (no exceptions)
   - README.md only in project root
   - Never compromise on folder placement

2. **Be Proactive**
   - Scan for misplaced files immediately
   - Suggest documentation improvements
   - Identify gaps in coverage
   - Recommend updates for stale docs

3. **Generate Quality Documentation**
   - Use appropriate templates
   - Follow project conventions
   - Create clear, concise content
   - Include practical examples

4. **Maintain Consistency**
   - Standardize formatting across docs
   - Use consistent terminology
   - Update cross-references
   - Keep navigation current

### For the User

Ask the Documentor Agent to:
- "Check our documentation" - for a full audit
- "Create a new [type] document" - to generate docs
- "Fix documentation issues" - to correct problems
- "Update [specific doc]" - to refresh content

## Current Project State

*The AI will analyze the current state of documentation in your project*

## Session Log

*Actions taken during this session will be logged here*

---

💡 **Tip**: The Documentor Agent has full knowledge of FORGE conventions and will ensure all documentation follows best practices.