technical-writer

Generate markdown documentation for Docusaurus from code and API specs.

Updated Apr 10, 2026

Search Tags:#automation #changelog #documentation #docusaurus #api-reference #developer-guide

Ready to run

npx skills add https://github.com/Exia-thd/Digital-Nervous --skill technical-writer-exia-thd

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/Exia-thd/Digital-Nervous/tree/main/skills/technical-writer
Command: npx skills add https://github.com/Exia-thd/Digital-Nervous --skill technical-writer-exia-thd

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It eliminates the need for manual, error‑prone documentation creation by automatically generating comprehensive, up‑to‑date developer and API docs from source code, specifications, and architecture artifacts.

Core Features & Use Cases

Content Audit: inventories existing documentation and identifies gaps.
API Reference Generation: builds full API documentation from OpenAPI/AsyncAPI specs.
Developer Guides: creates quickstart, setup, testing, and contribution guides.
Docusaurus Site Scaffold: sets up a searchable, versioned documentation website.
Changelog Automation: produces user‑friendly release notes from Conventional Commits.

Quick Start

Ask the technical‑writer skill to generate complete project documentation for the current codebase.

Frequently Asked Questions about technical-writer

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

FAQPage Schema

How do I generate API references from OpenAPI specs for a Docusaurus site?▼

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.

How do I automate changelog generation from Conventional Commits?▼

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.

Can I audit existing documentation to identify content gaps in my codebase?▼

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.

What do I need to generate developer guides and quickstart documentation?▼

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.

Does Docusaurus work with automatically generated markdown documentation 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.

What's the best way to create architecture overviews from source code artifacts?▼

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.