skills.rest
kaushal-waygood
kaushal-waygoodCOMMUNITY
Explore all skills by this author →
GitHub

documentation

Organize project documentation into structured Diátaxis sections with frontmatter metadata.

Updated Feb 26, 2026
Search Tags:#documentation#markdown#guides#seo#frontmatter#diataxis#astro-starlight
One-click install
npx skills add https://github.com/kaushal-waygood/agentic-self-healing-ci --skill documentation-kaushal-waygood
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/kaushal-waygood/agentic-self-healing-ci/tree/main/.github/skills/documentation
Command: npx skills add https://github.com/kaushal-waygood/agentic-self-healing-ci --skill documentation-kaushal-waygood

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Organizes complex project documentation into clear, purpose-driven sections so readers quickly find guidance, explanations, and references.

Core Features & Use Cases

  • Systematic guidance using four Diátaxis types (Tutorials, How-to Guides, Reference, Explanation) to cover learning, tasks, and technical details.
  • Consistent Markdown conventions and frontmatter to support SEO, navigation, and rendering with Astro Starlight.
  • Use cases include onboarding new contributors, enabling precise API references, and providing structured explanations for design decisions.

Quick Start

Create a beginner-friendly documentation page that uses the Diátaxis framework to guide setup, usage, and reference.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I structure project documentation using the Diátaxis framework?▼

To organize project documentation with the Diátaxis framework, you separate content into Tutorials, How-to Guides, Reference, and Explanation. This Skill enforces those four content types to improve discoverability and onboarding.

Can I use GitHub-flavored Markdown and frontmatter for Astro Starlight documentation?▼

Yes, this Skill enforces consistent Markdown conventions and frontmatter-based metadata to support SEO, navigation, and rendering with Astro Starlight. It processes GitHub-flavored Markdown to ensure your documentation renders correctly.

What is the best way to organize API references and architectural explanations for onboarding teams?▼

Organizing API references and architectural explanations is best achieved by separating content into Diátaxis categories. This Skill structures onboarding materials, precise API references, and design explanations into clear, purpose-driven sections.

Does this documentation approach work for multi-repo projects?▼

Yes, this Skill organizes project documentation across multi-repo projects. It applies consistent Markdown conventions and frontmatter metadata to improve discoverability and navigation for onboarding teams, API references, and architectural explanations.

When do I need Diátaxis content types for my project guides?▼

You need Diátaxis content types when your project documentation becomes complex and readers struggle to find guidance. The four types—Tutorials, How-to Guides, Reference, and Explanation—systematically cover learning, tasks, and technical details to improve discoverability.

Related Skills

Explore More Content & Communication Skills→
levi-qiaolevi-qiao
6

ingest

Extract and integrate markdown, PDF, and text files into a structured wiki knowledge base.

Community
Intermediate
az9713az9713

documentation

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

Community
Intermediate
lbliiilbliii
41

bengal-content-migration

Migrates static site and Markdown content to Bengal format.

Community
Intermediate
ghalacticghalactic
2

diataxis

Classify technical documentation into tutorials, guides, references, and explainers.

Official
Intermediate