documentation-engineer

Automating API documentation generation involves extracting API specifications like OpenAPI or Swagger from code annotations and passing them to documentation generators to produce developer-friendly references automatically. This Skill implements that workflow to keep docs synchronized with source code.

Documentation-as-code manages technical documentation alongside source code using the same version control workflows. This Skill implements these principles to ensure developer docs, tutorials, and architecture guides stay synchronized with code changes and are published with releases.

Yes, integrating documentation-as-code workflows requires compatibility with standard documentation generators. This Skill is designed to work with Sphinx, MkDocs, or Docusaurus to build and maintain developer-friendly documentation systems from API specifications.

Keeping API documentation synchronized with code requires automated workflows that detect new features and update relevant docs. This Skill automatically updates API documentation, including code examples and response schemas, ensuring it is published with the next release.

Analyzing documentation gaps involves reviewing existing developer docs against current code and API specifications. This Skill identifies missing tutorials, architecture guides, or API references to ensure comprehensive, developer-friendly content coverage across the project.

Yes, providing API specification tools like Swagger or OpenAPI is required. This Skill relies on these specs to automate the creation and maintenance of technical documentation, including generating code examples and response schemas for developer-friendly content.