Technical Writing

Guide technical content planning, drafting, and review workflows in English and Japanese.

71|2|Updated Feb 23, 2024
One-click install
npx skills add https://github.com/takeokunn/nixos-configuration --skill technical-writing-takeokunn
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Technical Writing
Source: https://github.com/takeokunn/nixos-configuration/tree/main/home-manager/programs/claude-code/skills/methodology/technical-writing
Command: npx skills add https://github.com/takeokunn/nixos-configuration --skill technical-writing-takeokunn

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams produce consistent, credible technical content for external audiences, reducing ambiguity and rework.

Core Features & Use Cases

  • Structured patterns for blogs and articles in English and Japanese.
  • Writing principles such as hook, inverted pyramid, show-dont-tell, and credibility.
  • Concrete workflows for planning, drafting, reviewing, and publishing technical content.

Quick Start

Draft a 1200-word tutorial explaining a given technical concept in English and Japanese, following the patterns and principles outlined above.

Frequently Asked Questions about Technical Writing

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

FAQPage Schema
How do I write technical blog posts that are consistent and credible?

Technical blog posts require structured patterns like the inverted pyramid and show-dont-tell principles to ensure consistency and credibility for external audiences. Following concrete workflows for planning, drafting, and reviewing further enforces evidence-based claims.

What are the best writing guidelines for multi-language technical documentation in English and Japanese?

The best writing guidelines for multi-language technical documentation involve applying structured patterns and language guidelines across both English and Japanese, ensuring consistent terminology and evidence-based claims throughout the planning and drafting workflows.

How does the inverted pyramid pattern work for technical writing?

The inverted pyramid pattern for technical writing places the most critical concept explanations and conclusions at the very beginning of the content. This structured pattern is followed by supporting details and evidence-based claims, allowing external audiences to grasp core concepts quickly before reading further.

Can I use these writing principles for drafting tutorials and concept explanations?

Yes, you can use these writing principles for drafting tutorials and concept explanations. The skill provides concrete workflows that enforce structured patterns, hooks, and quality controls specifically applied to tutorials and concept explanations for technical content aimed at external audiences.

What is the show-dont-tell principle in technical content creation?

The show-dont-tell principle in technical content creation is a writing guideline that requires demonstrating concepts through concrete examples and evidence-based claims rather than simply stating facts, making tutorials and blog posts more credible and engaging.