Technical Writing

Generate structured technical writing patterns for English and Japanese docs.

2|1|Updated Feb 2, 2024
One-click install
npx skills add https://github.com/mtaku3/nix-config --skill technical-writing-mtaku3
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Technical Writing
Source: https://github.com/mtaku3/nix-config/tree/main/modules/home/app/dev/claude-code/skills/technical-writing
Command: npx skills add https://github.com/mtaku3/nix-config --skill technical-writing-mtaku3

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Technical writers and teams often struggle to produce consistent, high-quality external-facing docs (blogs, tutorials, explanations) that resonate with both English and Japanese audiences. This skill provides ready-to-use patterns, style guidelines, and structure templates to accelerate content creation while maintaining clarity and credibility.

Core Features & Use Cases

  • Pattern-driven templates for tutorials, concept explanations, comparisons, case studies, and opinion pieces.
  • Language guidelines and bilingual writing rules to ensure consistency across English and Japanese content.
  • Step-by-step workflow guidance from ideation to drafting, editing, and polishing, including TL;DR and diagrams.

Quick Start

Provide a topic, audience, and desired article type (tutorial, concept explanation, or case study). The Skill will generate a structured outline and writing plan following the included patterns and principles. Then customize and publish your final piece.

Frequently Asked Questions about Technical Writing

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

FAQPage Schema
How do I generate bilingual technical writing guidelines for English and Japanese docs?

To generate bilingual technical writing guidelines, provide your topic, audience, and article type. The skill outputs structured patterns and language rules ensuring consistency across English and Japanese external-facing documentation.

What is the best way to structure a technical tutorial with markdown and YAML frontmatter?

The best way to structure a technical tutorial is using enforced markdown structures with required YAML frontmatter. This skill provides pattern-driven templates that enforce these formatting rules for reproducible drafting workflows.

Can I use this technical writing skill for case studies and concept explanations?

Yes, you can use this technical writing skill for case studies and concept explanations. It supplies ready-to-use pattern-driven templates for tutorials, comparisons, concept explanations, and opinion pieces across technical domains.

How does the bilingual drafting workflow handle TL;DR and diagrams?

The bilingual drafting workflow handles TL;DR and diagrams through step-by-step guidance from ideation to polishing. It enforces specific language guidelines and structural patterns to integrate these elements into your external-facing docs.

Do I need any specific dependencies to automate technical document creation?

You do not need any specific dependencies to automate technical document creation. The skill operates independently to apply writing patterns, bilingual principles, and reproducible workflows to your drafting process.

What are the limitations of using pattern-driven templates for external-facing docs?

A limitation of using pattern-driven templates for external-facing docs is that they enforce strict markdown and YAML frontmatter requirements. Writers must conform their content to these predefined structures rather than using freeform layouts.