documentation-writer

To generate developer documentation from source code, provide your target module's code or repository link. The skill reads the source to automatically produce maintainable README files, API docs, and architecture runbooks that accurately reflect the implementation.

Keeping API documentation aligned with a rapidly evolving codebase requires verifying accuracy against the source before publishing. This approach guides the creation of approachable docs by validating function signatures, parameters, and usage examples directly from your implementation.

Yes, automated documentation generation enforces consistent section structures. It ensures standard sections such as 'What problem does it solve?', 'Core Features & Use Cases', and 'Quick Start' are present, while also performing frontmatter validation before publishing.

Yes, you can create deployment runbooks and troubleshooting guides from existing code. The process extracts architectural details from your source to generate actionable documentation for team onboarding, deployment procedures, and troubleshooting.

To start generating API docs with function signatures and parameters, you need to provide the target module's code or repository link. The skill reads your source to extract function definitions, parameters, returns, and usage examples for the documentation.