technical-writer

Organize software documentation into Diataxis tutorials, how-tos, references, and explanations.

3|2|Updated Feb 27, 2026

Search Tags:#documentation #adr #diataxis #technical-writing #api-docs #readmes

Ready to run

npx skills add https://github.com/grasberg/sofia --skill technical-writer-grasberg

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/grasberg/sofia/tree/main/workspace/skills/technical-writer
Command: npx skills add https://github.com/grasberg/sofia --skill technical-writer-grasberg

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation is often inconsistent and time-consuming; this skill provides structured guidance and templates to produce high-quality docs at scale.

Core Features & Use Cases

Diataxis-based documentation production: tutorials (learning-oriented), how-tos (goal-oriented), references (information-oriented), explanations (understanding-oriented).
API documentation with complete examples, error handling, and versioned docs; ADRs and changelogs; architecture decisions; onboarding guides.
Standardized README templates and contributor guides to improve clarity and usability.

Quick Start

Create a complete API reference and user guide set for a new project following the Diataxis framework.

Frequently Asked Questions about technical-writer

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

FAQPage Schema

How do I structure technical documentation using the Diataxis framework?▼

The Diataxis framework structures technical documentation into four types: tutorials for learning, how-tos for goals, references for information, and explanations for understanding. Organizing your project into these categories ensures clarity and maintainability.

What is the best way to write API documentation with complete examples and error handling?▼

The best way to write API documentation is to use structured templates that enforce complete examples, error handling, and versioned docs. This approach ensures consistent style and runnable examples across your software project.

How do I create standardized README templates and contributor guides?▼

You create standardized README templates and contributor guides by applying consistent formatting rules and frontmatter metadata expectations. This improves clarity and usability for onboarding materials across your software projects.

Can I use this approach to generate architecture decision records and changelogs?▼

Yes, you can use this approach to generate architecture decision records (ADRs) and changelogs. It provides structured guidance to produce consistent ADRs and architecture decisions that capture your software evolution.

Does this documentation method support versioned docs and frontmatter metadata?▼

Yes, this documentation method supports versioned docs and satisfies frontmatter metadata expectations. It enforces clear formatting and strong accessibility standards to maintain high-quality docs at scale.