documentation-writer

Generate Diátaxis-aligned software documentation with frontmatter-driven templates.

17|1|Updated Mar 14, 2025
One-click install
npx skills add https://github.com/deckgl-fiber-renderer/fiber.gl --skill documentation-writer-deckgl-fiber-renderer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-writer
Source: https://github.com/deckgl-fiber-renderer/fiber.gl/tree/main/.agents/skills/documentation-writer
Command: npx skills add https://github.com/deckgl-fiber-renderer/fiber.gl --skill documentation-writer-deckgl-fiber-renderer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps technical teams craft high-quality software documentation using the Diátaxis framework, providing structured guidance and a consistent voice.

Core Features & Use Cases

  • Diátaxis-aligned output: Generates tutorials, how-tos, references, and explanations tailored to developer audiences.
  • Audience-driven voice and structure: Maintains clarity and accuracy for developer audiences across documentation types.
  • Frontmatter-driven discovery: Outputs metadata ready for indexing and discovery, integrating with your site generator.

Quick Start

Provide a complete, Diátaxis-aligned documentation draft for a new feature using the templates and frontmatter conventions.

Frequently Asked Questions about documentation-writer

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

FAQPage Schema
What is Diátaxis framework documentation and how does it structure technical writing?

Diátaxis framework structures technical writing into four quadrants: tutorials, how-tos, references, and explanations. This documentation approach separates learning goals to maintain clarity and audience focus for developer audiences.

How do I create software documentation with frontmatter templates?

You can create software documentation with frontmatter templates by using structured content workflows that generate Diátaxis-aligned drafts. This process outputs metadata ready for indexing, integrating directly with your site generator for discovery.

Can I use markdown to generate tutorials and how-tos for developer audiences?

Yes, you can use markdown to generate tutorials and how-tos for developer audiences. The skill produces audience-driven content that maintains a consistent voice and clarity across all four Diátaxis documentation types.

What is the best way to write technical documentation for a new software feature?

The best way to write technical documentation for a new feature is providing a complete, Diátaxis-aligned draft. Using frontmatter conventions and structured templates ensures the content meets criteria for accuracy and consistent structure.

Does this documentation workflow support custom frontmatter for site generator indexing?

Yes, this documentation workflow supports custom frontmatter for site generator indexing. It outputs frontmatter-driven metadata specifically designed for discovery, ensuring your tutorials and references integrate seamlessly with static site generators.