nw-divio-framework

Classify documentation into tutorial, how-to, reference, and explanation types.

Updated Mar 18, 2024
One-click install
npx skills add https://github.com/v1bh0r/precise-ledger-pro --skill nw-divio-framework-v1bh0r
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: nw-divio-framework
Source: https://github.com/v1bh0r/precise-ledger-pro/tree/main/nWave/skills/nw-divio-framework
Command: npx skills add https://github.com/v1bh0r/precise-ledger-pro --skill nw-divio-framework-v1bh0r

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

DIVIO/Diataxis four-quadrant framework standardizes documentation types to reduce confusion and improve discoverability across product docs, developer guides, references, and explanations.

Core Features & Use Cases

  • Four quadrant types: Tutorial, How-to Guide, Reference, and Explanation to cover learning, task execution, lookup, and rationale.
  • Classification signals and a decision tree to guide content organization and authoring workflows.
  • Signal catalog and naming conventions to enable consistent tagging and searchability across documentation artifacts.

Quick Start

Map your existing docs to the four quadrants and annotate each piece with its intended purpose.

Frequently Asked Questions about nw-divio-framework

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

FAQPage Schema
What is the Diataxis four-quadrant framework for documentation?

The Diataxis four-quadrant framework is a classification system that organizes documentation into Tutorial, How-to Guide, Reference, and Explanation types to standardize content and improve discoverability.

How do I classify existing product docs into tutorial, how-to, reference, and explanation types?

You classify product docs by mapping existing materials to the four quadrants using a decision tree and signal catalog, annotating each piece with its intended purpose to guide authoring workflows.

When should I use a tutorial versus a how-to guide in developer documentation?

Use a tutorial for learning-oriented content that guides users through a lesson, and use a how-to guide for task-oriented content that helps users achieve a specific goal.

How does a documentation decision tree and signal catalog improve content discoverability?

A documentation decision tree and signal catalog improve discoverability by providing consistent tagging and naming conventions, enabling clearer searchability and standardized organization across all documentation artifacts.

What is the best way to standardize developer guides and references to reduce documentation confusion?

The best way to standardize developer guides and references is applying the DIVIO framework to categorize materials into four distinct types, ensuring each document satisfies a specific classification signal.