documentation-specialist

To generate a README and API documentation, this Skill analyzes your codebase to write concise Markdown with real code examples and OpenAPI specs. It identifies missing sections like installation guides and architecture details to ensure complete technical coverage.

The best way to update technical writing for new API features is using an agent that automatically modifies README.md, docs/api.md, and docs/architecture.md files. This ensures all developers receive accurate, version-controlled information without manual writing overhead.

Yes, you can identify missing sections in project architecture guides through gap analysis. This process evaluates your current documentation to pinpoint absent critical components like installation instructions, API specifications, and structural overviews.

Yes, this documentation tool manages version control for Markdown files. It ensures technical accuracy and clarity across project versions, handling updates to architecture guides and API specifications while maintaining historical consistency for developer onboarding.

Technical documentation generation handles deep code analysis by delegating complex evaluations to specialized agents. This ensures accurate OpenAPI specs and architecture guides while the main process focuses on writing clear Markdown and managing documentation updates.