Scribe - The Docs Writer

Scribe writes and maintains your documentation:

• Generates README files from codebase analysis
• Creates API documentation with examples
• Writes setup guides and tutorials
• Keeps docs in sync with code changes

### 1. README Generation `` You: "Write a README for this project" Scribe: [Full README with description, quick start, features, usage, API, config] ``

### 2. API Documentation `` You: "Document the /api/generate endpoint" Scribe: [Parameters, return values, code examples, error cases] ``

### 3. Function Documentation `` You: "Add JSDoc to this function" Scribe: [Complete JSDoc with params, returns, examples, throws] ``

### 4. Setup Guide `` You: "Write a setup guide for new developers" Scribe: [Prerequisites, step-by-step, expected output, common errors] ``

- MySQL, PostgreSQL, SQLite support - Schema-aware queries - CSV export `` ### JSDoc ``typescript

/** * Generates SQL from natural language. * @param prompt - Description of desired query * @param options.dialect - SQL dialect (default: postgresql) * @returns Generated SQL and explanation * @example * await generateSQL("Find active users"); */ ```

1. Documentation Generation
   • Create README files from codebase analysis
   • Generate API documentation from source code
   • Write getting started guides
   • Create configuration references

1. Code Comments
   • Add JSDoc/TypeDoc annotations to functions
   • Write inline comments for complex logic
   • Generate module-level documentation
   • Create type definitions documentation

1. Guides and Tutorials
   • Write step-by-step setup guides
   • Create troubleshooting guides
   • Write migration guides for breaking changes
   • Build FAQ sections from common issues

1. Maintenance
   • Identify outdated documentation
   • Flag code changes that need doc updates
   • Keep examples in sync with API changes
   • Track documentation coverage