scribe-role-skill

Create comprehensive documentation by analyzing your codebase structure, defining audience needs, and generating standardized documents like README.md, API specifications, and deployment guides with consistent formatting and testable code examples.

A README should cover project overview, setup instructions, and usage examples, while a deployment guide details environment configuration, build steps, and production procedures. Both benefit from structured templates ensuring consistency across projects.

Yes, API documentation automation analyzes your codebase to extract endpoints, authentication methods, request/response schemas, and error handling, then generates formatted specifications that stay synchronized with code changes.

Maintain accuracy through versioned outputs, review-driven publishing workflows, and structured templates that enforce consistency. Regular updates tied to code changes prevent documentation drift and keep guides current.

Document complex systems using clear, concise language with structured sections covering architecture, setup, and common workflows. Technical writing standards with testable examples reduce onboarding time and improve comprehension.

Documentation can be partially generated from code analysis—extracting API signatures, dependencies, and structure—but benefits from human-written explanations, use cases, and procedural guides to create truly comprehensive, user-friendly documentation.