classify-diataxis

Classify documentation pages into Diátaxis type categories.

7|7|Updated Feb 2, 2015
One-click install
npx skills add https://github.com/giantswarm/docs --skill classify-diataxis
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: classify-diataxis
Source: https://github.com/giantswarm/docs/tree/main/.claude/skills/classify-diataxis
Command: npx skills add https://github.com/giantswarm/docs --skill classify-diataxis

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill accurately classifies documentation pages into their appropriate Diátaxis type, ensuring consistent content categorization and easy navigation.

Core Features & Use Cases

  • Automated Classification: Determine the Diátaxis type of pages programmatically.
  • Type Identification: Identify if the page is a 'tutorial', 'how-to-guide', 'reference', or 'explanation'.
  • Mixed Content Detection: Flag pages that mix multiple Diátaxis types for further review.
  • Use Case: Classify a batch of documentation pages for an update or review, streamlining the categorization process.

Quick Start

Classify the content type of the document at 'src/content/tutorials/guides/quick-start.md'.

Frequently Asked Questions about classify-diataxis

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

FAQPage Schema
How do I classify documentation pages into Diátaxis framework categories?

You classify documentation pages into Diátaxis categories using automated scripts that determine if a page is a tutorial, how-to-guide, reference, or explanation. This ensures consistent content categorization and easy navigation.

What is the Diátaxis framework used for in document classification?

The Diátaxis framework is used to categorize documentation into tutorials, how-to-guides, references, and explanations. Automated classification applies predefined criteria to identify page types, streamlining content organization and improving user experience.

How do I detect mixed content types in a documentation page?

Detecting mixed content types involves flagging pages that blend multiple Diátaxis categories for further review. This identification process prevents ambiguous documentation structures and maintains strict framework compliance.

Can I batch classify multiple documentation pages for an update?

Batch classifying documentation pages is supported by running scripts against a directory of files. This workflow automation processes multiple pages programmatically, streamlining the categorization process for content updates or reviews.

Does automated Diátaxis classification work with standard markdown files?

Automated Diátaxis classification works with standard markdown files by applying predefined criteria to the content. The scripts evaluate the document structure and text to accurately identify the appropriate Diátaxis type.

Why flag a documentation page as mixing multiple Diátaxis types?

Flagging a page that mixes multiple Diátaxis types highlights ambiguous content that fails to fit a single category. This detection ensures documentation purity by sending mixed pages for review to maintain clear content boundaries.