authoring

tenzir's avatarfrom tenzir

Author documentation for Tenzir projects. Use when creating or updating tutorials, guides, explanations, reference, or integrations.

⭐2stars🔀0forks📁View on GitHub🕐Updated Jan 2, 2026⬇️1downloads

When & Why to Use This Skill

This Claude skill streamlines the creation and maintenance of technical documentation for Tenzir projects. Built upon the Diátaxis framework, it assists users in generating structured tutorials, goal-oriented guides, conceptual explanations, and detailed technical references. It automates the entire documentation lifecycle, including MDX file creation, style-consistent reviews, and GitHub pull request management to ensure high-quality, user-centric documentation.

Use Cases

  • Developing learning-oriented tutorials to help new users get started with Tenzir projects.
  • Creating task-based guides that provide clear, step-by-step instructions for accomplishing specific technical goals.
  • Drafting technical reference documentation for TQL (Tenzir Query Language) and API specifications using MDX.
  • Documenting third-party product integrations to explain how external tools interact with the Tenzir ecosystem.
  • Automating the documentation review process and PR creation to maintain style consistency and content completeness.
nameauthoring
descriptionAuthor documentation for Tenzir projects. Use when creating or updating tutorials, guides, explanations, reference, or integrations.

Authoring Documentation

Author documentation for Tenzir projects following the Diátaxis framework.

Diátaxis Framework

Tenzir documentation uses the Diátaxis framework, which organizes content into four quadrants based on user needs:

Section Purpose Reader question
Tutorials Learning-oriented lessons "I want to learn"
Guides Goal-oriented how-tos "I want to accomplish X"
Explanations Understanding-oriented "I want to understand"
Reference Information-oriented "I need facts"

See diataxis.md for the decision tree and section guidelines.

Integrations

Separately from Diátaxis, Integrations documents third-party products: "How do I use X with Tenzir?"

Organized by vendor/category: integrations/<category>/<product>.mdx

Directory Structure

Documentation content lives at src/content/docs/ relative to the documentation root.

src/content/docs/
├── tutorials/      # Learning-oriented projects
├── guides/         # Task-oriented how-tos
├── explanations/   # Conceptual understanding
├── reference/      # Technical specifications (some auto-generated)
└── integrations/   # Third-party products by vendor

File Format

  • Use .mdx for new files
  • Add frontmatter with title and description
  • Use tql as the language identifier for TQL code blocks

See format.md for frontmatter and code block details.

Writing Style

Invoke prose:technical-writing for detailed style guidance.

Workflow

  1. Run /docs:write to create or update documentation
  2. Run /docs:review to check completeness and style
  3. Create a PR using git -C .docs and gh pr create --repo tenzir/docs