documentation-writer

Standardize technical documentation creation using the Diátaxis framework.

Updated Jul 24, 2026

Search Tags:#documentation #technical writing #developer experience #authoring #software #diátaxis

Ready to run

npx skills add https://github.com/rotnov/pycc --skill documentation-writer-rotnov

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-writer
Source: https://github.com/rotnov/pycc/tree/main/.agents/skills/documentation-writer
Command: npx skills add https://github.com/rotnov/pycc --skill documentation-writer-rotnov

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill addresses the challenge of creating inconsistent or poorly structured technical documentation by enforcing the Diátaxis framework, ensuring content is purpose-driven and easy for users to navigate.

Core Features & Use Cases

Diátaxis Alignment: Structures documentation into tutorials, how-to guides, technical references, and explanations.
Standardized Authoring: Ensures all technical content follows a proven pedagogical structure for software projects.
Use Case: Use this skill to transform raw developer notes or API specifications into a cohesive, professional documentation suite that helps new users onboard quickly.

Quick Start

Ask the documentation writer to draft a new how-to guide for the current project based on the provided technical requirements.

Frequently Asked Questions about documentation-writer

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

FAQPage Schema

How do I structure technical documentation using the Diátaxis framework?▼

The Diátaxis framework structures technical documentation by dividing content into four distinct types: tutorials, how-to guides, technical references, and explanations. This Skill applies that framework to your software project to ensure content is purpose-driven and easy to navigate.

What is the best way to turn raw developer notes into a cohesive documentation suite?▼

The best way to transform raw developer notes or API specifications into a cohesive documentation suite is by applying standardized authoring principles. This Skill processes your technical requirements to generate professional, structured content that improves developer experience and onboarding.

Can I generate how-to guides and tutorials for a complex codebase automatically?▼

Yes, you can generate tutorials and how-to guides for a complex codebase by providing the technical requirements to this Skill. It facilitates the creation of these documents while ensuring they adhere to structured pedagogical principles for software projects.

Does this documentation writer work for improving developer experience with existing API specifications?▼

Yes, this documentation writer works for improving developer experience by transforming existing API specifications into structured reference materials. It enforces proven pedagogical structures to ensure technical content is accessible and purpose-driven.

When should I use Diátaxis alignment over other technical writing approaches?▼

You should use Diátaxis alignment when you need to solve the problem of creating inconsistent or poorly structured technical documentation. It ensures your content is standardized into specific pedagogical categories rather than unstructured blocks.