skills.rest
nahisaho
nahisahoCOMMUNITY
Explore all skills by this author →
GitHub

technical-writer

Generate READMEs and API references from OpenAPI specs with Japanese translations.

69|5|Updated Nov 16, 2025
Search Tags:#templates#documentation#markdown#readme#technical-writing#api-docs#apis
One-click install
npx skills add https://github.com/nahisaho/musubi --skill technical-writer-nahisaho
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/nahisaho/musubi/tree/main/.claude/skills/technical-writer
Command: npx skills add https://github.com/nahisaho/musubi --skill technical-writer-nahisaho

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Crafting clear, accurate technical docs is slow and error-prone. This Skill automates the creation and maintenance of project documentation, including READMEs, API references, user guides, and tutorials, so teams ship better docs faster.

Core Features & Use Cases

  • Template-driven documentation: Generate READMEs, developer guides, and user manuals from code and specs.
  • API Documentation: Produce OpenAPI/Swagger-compliant docs (Swagger UI, Redoc) from API specs and annotations.
  • Consistency at scale: Enforce terminology, style, and structure across all docs.
  • Use Case: You’re releasing a new API; generate a complete API Reference and a starter README from an OpenAPI spec.

Quick Start

Create a README.md and an API Reference from the OpenAPI spec located at 'api/openapi.yaml'.

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I generate a README and API documentation from an OpenAPI spec?▼

Generate README and API documentation automatically from your OpenAPI spec by applying templates to extract endpoint definitions, parameters, and examples. This creates consistent, maintainable docs that stay synchronized with your API as it evolves.

What's the best way to keep technical documentation consistent across multiple files?▼

Enforce consistency by applying shared templates, terminology standards, and style rules across README, API docs, user guides, and runbooks. This prevents scattered formatting and conflicting information while reducing manual maintenance overhead.

Can I automate documentation updates when my API or codebase changes?▼

Yes. Automate doc generation from code annotations, OpenAPI specs, and JSDoc comments so documentation updates reflect API changes without manual rewrites, keeping guides accurate and reducing release friction.

Does this work with OpenAPI and Swagger specifications?▼

This Skill produces OpenAPI/Swagger-compliant documentation including Swagger UI and Redoc output from your API specs and annotations, enabling standard API reference generation.

What types of documentation can be generated with templates?▼

Generate READMEs, API references, developer guides, user manuals, tutorials, release notes, setup instructions, usage examples, and architecture documentation from code, specs, and configuration templates.

Related Skills

Explore More Content & Communication Skills→
armanzeroeightarmanzeroeight
29

api-docs-generator

Generate API documentation from code into HTML or JSON formats.

Community
Intermediate
christophevgchristophevg

api2mod

Convert API documentation or specifications into importable Python client modules.

Community
Intermediate
a747895159a747895159

doc-translator

Translate English technical documents into fluent Chinese while preserving formatting and code blocks.

Community
Intermediate
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate