Technical Writing

Generate structured patterns and guidelines for technical content in English and Japanese.

Updated Mar 15, 2025
One-click install
npx skills add https://github.com/yasushiasahi/nix-config --skill technical-writing-yasushiasahi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Technical Writing
Source: https://github.com/yasushiasahi/nix-config/tree/main/home-manager/agent-skills/skills/technical-writing
Command: npx skills add https://github.com/yasushiasahi/nix-config --skill technical-writing-yasushiasahi

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill assists users in creating high-quality technical content, such as blog posts, articles, and tutorials, ensuring clarity, accuracy, and engagement for external audiences.

Core Features & Use Cases

  • Content Structuring: Provides predefined patterns for various article types (tutorials, concept explanations, comparisons, case studies, opinion pieces).
  • Writing Principles: Offers guidance on effective writing techniques like hooking the reader, showing rather than telling, and respecting the reader's time.
  • Language Adaptation: Includes guidelines for writing in both English and Japanese, ensuring cultural and linguistic appropriateness.
  • Use Case: A developer needs to write a tutorial on a new framework. This Skill can provide a structured outline, suggest code example formats, and offer best practices for explaining complex concepts clearly.

Quick Start

Use the technical writing skill to generate an outline for a tutorial on setting up a new web server.

Frequently Asked Questions about Technical Writing

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

FAQPage Schema
How do I structure a technical blog post for a new software framework?

Structure a technical blog post using predefined patterns for tutorials or concept explanations that hook the reader and format code examples clearly. This ensures your framework explanation remains engaging and respects the reader's time.

What is the best way to write a tutorial that explains complex technical concepts?

The best way to write a tutorial is applying writing principles that show rather than tell while respecting the reader's time. This approach provides structured outlines and suggests code example formats to explain complex technical concepts clearly.

Can I get guidelines for writing technical documentation in both English and Japanese?

Yes, you can get guidelines for writing technical documentation in both English and Japanese. This provides language-specific style guidelines ensuring cultural and linguistic appropriateness for content creation across both languages.

Does this technical writing skill provide templates for case studies and opinion pieces?

Yes, this technical writing skill provides predefined structured patterns for case studies and opinion pieces. These templates offer frameworks for different article types to ensure clear, engaging, and accurate technical communication.

How do I generate a structured outline for an article about setting up a web server?

To generate a structured outline for an article about setting up a web server, use the tutorial pattern framework. This supplies writing principles and output formats to structure your content creation process accurately for external audiences.