technical-writer

Generate API references by extracting information from OpenAPI or AsyncAPI specifications to build full API documentation, producing markdown files organized for a Docusaurus site. This eliminates manual documentation creation by automatically converting specs into structured reference pages.

Automate changelog generation by processing Conventional Commits from repository metadata to produce user-friendly release notes. This automatically extracts commit history and transforms standardized commit messages into readable, structured markdown changelogs.

Audit existing documentation by inventorying current docs and identifying gaps across multiple phases of documentation creation. This content audit examines source files and architecture artifacts to pinpoint missing API references, developer guides, or architecture overviews.

Generate developer guides by requiring access to source files, OpenAPI or AsyncAPI specs, and repository metadata to create quickstart, setup, testing, and contribution guides. Optional configuration files can further refine the output markdown files.

Docusaurus works with automatically generated markdown files by setting up a searchable, versioned documentation website scaffold. The generated documentation is organized specifically for Docusaurus, enabling instant deployment of production-grade docs.

Create architecture overviews by extracting information from source code, specifications, and architecture artifacts to generate comprehensive markdown documentation. This approach ensures up-to-date architecture documentation by analyzing the actual codebase structure.