skills.rest
Objective-Arts
Objective-ArtsOFFICIAL
Explore all skills by this author →
GitHub

docs

Structure documentation into tutorials, how-to guides, references, and explanations.

Updated Feb 17, 2026
Search Tags:#documentation#content strategy#technical writing#diataxis#writing framework
One-click install
npx skills add https://github.com/Objective-Arts/lens-dist --skill docs-objective-arts
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/Objective-Arts/lens-dist/tree/main/canon/docs
Command: npx skills add https://github.com/Objective-Arts/lens-dist --skill docs-objective-arts

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you organize and create documentation that effectively serves different reader needs, preventing common pitfalls like mixing purposes within a single document.

Core Features & Use Cases

  • Diátaxis Framework: Understand and apply the four types of documentation (Tutorial, How-To, Reference, Explanation).
  • Content Structuring: Learn best practices for organizing content within each type.
  • Use Case: When writing a new feature's documentation, use this Skill to determine whether to create a tutorial for beginners, a how-to guide for specific tasks, a technical reference for API details, or an explanation for design rationale.

Quick Start

Use the docs skill to understand the Diátaxis framework for structuring documentation.

Frequently Asked Questions about docs

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

FAQPage Schema
What is the Diátaxis framework for documentation?▼

The Diátaxis framework structures documentation into tutorials, how-to guides, technical references, and explanations. It separates content purposes to serve distinct reader needs and prevents mixing goals within a single document.

How do I structure technical writing to avoid mixing purposes?▼

Structure technical writing by applying the Diátaxis framework to separate content into tutorials, how-to guides, references, and explanations. Use provided decision trees and placement guidelines to categorize content and enforce quality checklists.

When should I use a tutorial versus a how-to guide?▼

Use tutorials for beginners learning a feature and how-to guides for specific task execution. The Diátaxis framework provides decision trees to determine whether content should be a tutorial, how-to guide, reference, or explanation based on its purpose.

What are common anti-patterns in content strategy for technical references?▼

Common anti-patterns in technical references include mixing explanations or task instructions into reference material. The framework highlights these anti-patterns and enforces quality checklists to ensure references remain strictly technical and purpose-focused.

Does this approach work for structuring API documentation?▼

Yes, this approach works for API documentation by placing API details in technical references, while using explanations for design rationale and how-to guides for specific implementation tasks. It ensures content organization matches reader intent.

Related Skills

Explore More Content & Communication Skills→
wahidyankfwahidyankf
3

docs-applying-diataxis-framework

Categorize technical documentation into Diátaxis types and map them to directories.

Community
Intermediate
az9713az9713

documentation

Organizes project documentation into Diátaxis categories using Markdown and Astro Starlight.

Community
Intermediate
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate
vasilyu1983vasilyu1983
73

docs-codebase

Generate documentation templates for READMEs, ADRs, API docs, and changelogs.

Community
Intermediate