technical-documentation

Categorize technical documentation into tutorials, how-to guides, references, and explanations.

5|3|Updated May 17, 2020
One-click install
npx skills add https://github.com/ryanquinn3/dotfiles --skill technical-documentation-ryanquinn3
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-documentation
Source: https://github.com/ryanquinn3/dotfiles/tree/main/claude/.claude/skills/technical-documentation
Command: npx skills add https://github.com/ryanquinn3/dotfiles --skill technical-documentation-ryanquinn3

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you create, organize, and audit documentation by ensuring each piece caters to a specific user need, avoiding mixed content and confusion.

Core Features & Use Cases

  • Categorizes documentation into tutorials, how-to guides, references, and explanations for clarity.
  • Provides templates and recommendations to structure content effectively.
  • Use case: A technical writer wants to reorganize existing documentation so that tutorials teach new users, while references provide detailed technical specs, streamlining content development.

Quick Start

Create organized documentation using the provided templates and categorize existing guides for better clarity.

Frequently Asked Questions about technical-documentation

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

FAQPage Schema
What is the Diátaxis framework for technical documentation?

The Diátaxis framework is a documentation structure that categorizes content into tutorials, how-to guides, references, and explanations to ensure each piece caters to a specific user need. It resolves mixed content confusion by organizing technical writing around distinct user goals.

How do I organize technical documentation into clear categories?

You organize technical documentation by applying the Diátaxis framework to separate content into tutorials for learning, how-to guides for tasks, references for specs, and explanations for concepts. This categorization streamlines content development and ensures docs address specific user needs.

Does organizing documentation with this framework require prior knowledge of documentation standards?

Yes, categorizing and auditing documentation with this framework requires existing knowledge of documentation standards and template application. It is suitable for technical writers and documentation teams who need to structure content effectively and reorganize existing guides.

What is the best way to structure technical writing to avoid mixed content?

The best way to avoid mixed content is to categorize documentation strictly by user need using the Diátaxis framework. By separating tutorials from technical references and explanations, you provide clear templates and structure content effectively without overlapping purposes.

Can I use templates to audit and reorganize existing documentation?

Yes, you can use provided templates to audit and reorganize existing documentation. The framework helps you categorize current guides so that tutorials teach new users while references provide detailed technical specs, systematically streamlining your content.