Does this skill support TQL code blocks?

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

Does it provide writing style guidance?

While this skill focuses on structure and authoring, it is designed to invoke the 'dev:technical-writing' skill for detailed linguistic and style guidance.

What file format does the Tenzir docs-authoring skill use?

It primarily uses the .mdx format for new files, including specific frontmatter fields like title and description.

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

Diátaxis is a systematic approach to technical documentation that organizes content into four categories: tutorials for learning, guides for tasks, explanations for understanding, and reference for facts.

Can I use this skill to document third-party integrations?

Yes, it includes a specific workflow for documenting third-party products, organized by vendor and category under the integrations directory.

Tenzir Documentation Authoring

Name: Tenzir Documentation Authoring
Author: tenzir

bytenzir

•

Aprendizaje y Documentación

Authors and structures technical documentation for Tenzir projects using the Diátaxis framework and MDX formatting.

The Tenzir Documentation Authoring skill is a specialized tool designed to streamline the creation and maintenance of technical content within the Tenzir ecosystem. It enforces the Diátaxis framework, ensuring that documentation is logically organized into tutorials, guides, explanations, and reference materials based on specific user needs. The skill manages complex directory structures, handles MDX frontmatter, and ensures correct syntax highlighting for TQL code blocks, making it an essential utility for developers looking to produce high-quality, consistent documentation autonomously.

Características Principales

01Seamless integration with technical writing and automated publishing workflows

023 GitHub stars

03Support for TQL (Tenzir Query Language) specific code blocks

04Diátaxis framework implementation for structured content organization

05Automated MDX file creation with pre-configured frontmatter

06Categorized third-party integration documentation management

Casos de Uso

01Documenting third-party product integrations within the Tenzir directory structure

02Authoring goal-oriented 'how-to' guides for specific technical tasks

03Generating learning-oriented tutorials for new Tenzir features

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add tenzir/claude-plugins docs-authoring

For use in Claude.ai and ChatGPT

Download Skill