writing

Generate Diátaxis-aligned documentation for Tenzir projects with MDX formatting.

2|Updated Dec 3, 2025
One-click install
npx skills add https://github.com/tenzir/claude-plugins --skill writing-tenzir
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing
Source: https://github.com/tenzir/claude-plugins/tree/main/plugins/docs/skills/writing
Command: npx skills add https://github.com/tenzir/claude-plugins --skill writing-tenzir

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you write documentation for Tenzir projects using the Diátaxis framework, ensuring consistent structure and clear guidance.

Core Features & Use Cases

  • Diátaxis organization: Classify content into Tutorials, Guides, Explanations, and Reference.
  • Integrations docs: Document third-party products with a consistent format.
  • Structured formats: Use frontmatter for metadata and MDX/MDoc formats for content.

Quick Start

Create or update documentation by running /docs:write, review with /docs:review, and publish with /docs:pr.

Frequently Asked Questions about writing

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

FAQPage Schema
How do I write technical documentation using the Diátaxis framework?

Diátaxis-aligned documentation organizes content into four types: Tutorials for learning, Guides for tasks, Explanations for concepts, and Reference for specifications. This Skill applies Diátaxis structure across Tenzir projects, ensuring each doc type serves its intended purpose and audience clearly.

What's the workflow for creating and publishing documentation with MDX and frontmatter?

Create or update docs using `/docs:write` with MDX formatting and frontmatter metadata (title and description), review changes with `/docs:review`, then publish via `/docs:pr`. This workflow ensures consistent structure and quality before content goes live.

Can I document third-party integrations with a consistent format?

Yes. This Skill includes a structured format for documenting integrations, applying the same Diátaxis principles and MDX formatting across third-party product documentation to maintain consistency alongside tutorials, guides, and reference material.

How do I format code examples in technical documentation?

Use fenced code blocks with language identifiers (tql, sh, json, yaml). Adjacent code blocks merge automatically, letting you combine related snippets while keeping each language explicitly labeled for clarity and syntax highlighting.

What documentation structure works best for Tenzir projects?

Structure documentation across five content types: tutorials for project-based learning, guides for task-focused how-tos, explanations for conceptual understanding, reference for technical specifications, and integrations for third-party products—all unified under Diátaxis principles.

Do I need prior knowledge of Diátaxis to use this Skill?

No. This Skill applies Diátaxis structure automatically, handling classification and organization. You provide content and metadata; the Skill ensures alignment with Diátaxis best practices for tutorials, guides, explanations, and reference documentation.