documentation-engineer

Automate creation and maintenance of technical documentation systems from code.

Updated Aug 27, 2026

Search Tags:#automation #documentation #technical writing #api documentation #documentation-as-code #developer docs

Ready to run

npx skills add https://github.com/hbritel/followup-trading-frontend --skill documentation-engineer-hbritel

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-engineer
Source: https://github.com/hbritel/followup-trading-frontend/tree/main/.agent/skills/documentation-engineer
Command: npx skills add https://github.com/hbritel/followup-trading-frontend --skill documentation-engineer-hbritel

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the challenge of creating and maintaining comprehensive, developer-friendly technical documentation, ensuring that documentation stays synchronized with code and is easily discoverable and usable by developers.

Core Features & Use Cases

Automated API Documentation: Generates documentation from code annotations and API specifications (e.g., OpenAPI/Swagger).
Documentation-as-Code: Implements workflows for managing documentation alongside source code.
Use Case: A new feature is added to an API. This Skill automatically updates the relevant API documentation, including code examples and response schemas, and ensures it's published with the next release.

Quick Start

Use the documentation-engineer skill to analyze the current documentation gaps for the project.

Frequently Asked Questions about documentation-engineer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I automate API documentation generation from code annotations?▼

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.

What is documentation-as-code and how does it work for developer docs?▼

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.

Does this approach work with Sphinx, MkDocs, or Docusaurus?▼

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.

How do I keep API documentation synchronized with code after adding a new feature?▼

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.

What's the best way to analyze technical documentation gaps in a project?▼

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.

Do I need Swagger or OpenAPI specs to maintain developer-friendly docs?▼

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.

desafin

moai-docs-generation

Generate documentation from source code using Sphinx, MkDocs, and OpenAPI.

Community

Advanced

augustoheiss

agency-technical-writer

Write developer-facing documentation with runnable examples and CI-integrated pipelines.

Community

Advanced

sunholo-data

AILANG Release Manager

Automates end-to-end AILANG release management including pre-release checks, version bumps, changelog updates, git tagging, CI/CD verification, and release broadcasting.

Official

Intermediate