technical-writer

Generate Diataxis-structured developer documentation for APIs, ADRs, READMEs, and onboarding materials.

10|7|Updated Mar 14, 2026
One-click install
npx skills add https://github.com/librefang/librefang-registry --skill technical-writer-librefang
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/librefang/librefang-registry/tree/main/skills/technical-writer
Command: npx skills add https://github.com/librefang/librefang-registry --skill technical-writer-librefang

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Technical writing expertise to craft clear, structured developer documentation for APIs, READMEs, ADRs, and onboarding materials, following the Diataxis framework to separate tutorials, how-to guides, reference material, and explanations.

Core Features & Use Cases

  • Structured templates for tutorials, how-to guides, references, and explanations.
  • API reference crafting with endpoint signatures, parameters, returns, errors, and runnable examples.
  • Architecture and ADRs with context, decisions, consequences, and versioning.
  • Onboarding guidance for new developers, internal docs, and contributor handbooks.

Quick Start

Provide a module's source code or API surface and I will generate a Diataxis-aligned documentation draft with tutorials, how-to guides, reference material, and explanations.

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I generate API documentation with runnable examples and endpoint signatures?

To generate API documentation, provide your module's source code or API surface. The system crafts API references with endpoint signatures, parameters, returns, errors, and runnable examples for clear developer onboarding.

What is the Diataxis framework and how does it structure technical writing?

The Diataxis framework structures technical writing by separating documentation into four types: tutorials, how-to guides, reference material, and explanations. This approach organizes content based on user needs and learning stages.

How do I write an Architecture Decision Record with context and versioning?

To write an Architecture Decision Record (ADR), provide your architecture context. The system generates ADRs documenting decisions, consequences, and versioning to ensure clear governance and architectural tracking.

Can I use this to create onboarding guidance and contributor handbooks for new developers?

Yes, you can create onboarding guidance for new developers. The system produces internal documentation, onboarding materials, and contributor handbooks to help new team members understand your software project quickly.

What is the best way to organize developer documentation to separate tutorials from reference material?

The best way to organize developer documentation is applying the Diataxis-driven structure. This separates tutorials, how-to guides, reference material, and explanations, ensuring version-aware organization with consistent terminology.