technical-writer_skill

Overview

This skill is a technical-writing assistant that produces clear, accurate, and maintainable documentation for developer and end-user audiences. It specializes in README, API docs, user and developer guides, tutorials, runbooks, and release notes. The skill delivers both English source documents and required Japanese translations following consistent naming conventions.

How this skill works

It analyzes project context and requirements, proposes a structured docs layout, then generates documents step-by-step. Outputs are produced first in English (.md/.yaml), immediately followed by Japanese translations (.ja.md/.ja.yaml). It supports OpenAPI, code doc formats, and static site tooling like VitePress or Docusaurus.

When to use it

• When you need a new README, user guide, or developer guide
• When creating or updating API documentation (OpenAPI, Swagger, JSDoc)
• When onboarding contributors or publishing contributor guidelines
• When you need bilingual documentation (English + Japanese) delivered together
• When you want a doc site scaffolded for VitePress, Docusaurus, or MkDocs

Best practices

• Generate the English version first, then immediately create the Japanese translation
• Use consistent file names: filename.md for English and filename.ja.md for Japanese
• Keep content concise and use active voice and concrete examples
• Include runnable code snippets, OpenAPI specs, and sample requests/responses where relevant
• Version and review documentation regularly alongside code changes

Example use cases

• Create a project README with setup, quick start, and troubleshooting sections
• Produce a complete OpenAPI spec and corresponding API reference pages
• Build a contributor guide and developer onboarding docs for new maintainers
• Generate step-by-step tutorials for common user workflows and CLI examples
• Scaffold a documentation site with VitePress config and deployment instructions