What is the Diátaxis framework used by this skill?

Diátaxis is a systematic approach to documentation that organizes content into four quadrants: Tutorials (learning), Guides (tasks), Explanations (understanding), and Reference (facts).

Does this skill support MDX formatting?

Yes, it creates documentation files in .mdx format and automatically includes required frontmatter like titles and descriptions.

How does it handle Tenzir-specific code?

The skill specifically uses 'tql' as the language identifier for code blocks to ensure proper syntax highlighting for Tenzir Query Language.

Can I use this skill to create Pull Requests?

Yes, the skill includes a specific workflow command (/docs:pr) to help transition from writing to the contribution phase.

Tenzir Documentation Writing

Name: Tenzir Documentation Writing
Author: tenzir

bytenzir

•

Learning & Documentation

Writes and maintains Tenzir project documentation following the Diátaxis framework and technical writing best practices.

This skill empowers Claude to author high-quality documentation for Tenzir projects by strictly adhering to the Diátaxis framework, which categorizes content into tutorials, guides, explanations, and references. It automates the creation of MDX files with appropriate frontmatter, manages the specific directory structure required for Tenzir repositories, and ensures technical accuracy using TQL code blocks. By integrating with style guidelines and a structured workflow, the skill streamlines the entire process from drafting content to submitting pull requests.

Key Features

01Integrated workflow commands for writing, reviewing, and PR creation

021 GitHub stars

03Supports specialized TQL language identifiers for code blocks

04Implements the Diátaxis framework for structured, user-centric content

05Automates MDX file creation with mandatory title and description frontmatter

06Manages hierarchical directory structures for tutorials, guides, and reference

Use Cases

01Updating technical reference specifications and conceptual explanations

02Documenting a third-party vendor integration in the dedicated integrations directory

03Creating a new learning-oriented tutorial for Tenzir beginners

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add tenzir/claude-plugins writing

For use in Claude.ai and ChatGPT

Download Skill