How-To Documentation

Create consistent how-to documentation with YAML frontmatter and Markdown sections.

18|Updated Jan 19, 2026
One-click install
npx skills add https://github.com/DRMacIver/claude-reliability --skill how-to-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: How-To Documentation
Source: https://github.com/DRMacIver/claude-reliability/tree/main/skills/documentation
Command: npx skills add https://github.com/DRMacIver/claude-reliability --skill how-to-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams and individuals create clear, repeatable how-to guides, capturing procedures so they can be consistently followed and reused.

Core Features & Use Cases

  • Provides a standardized structure for documenting procedures.
  • Supports sharing and reusing guidance across projects and teams.
  • Helps capture decisions, steps, prerequisites, and troubleshooting to reduce onboarding time and errors.

Quick Start

Create a new how-to guide by outlining the task, its prerequisites, steps, and a brief troubleshooting section; then provide a concise one-sentence action you want the AI to perform next.

Frequently Asked Questions about How-To Documentation

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

FAQPage Schema
How do I create consistent how-to documentation for team procedures?

To create consistent how-to documentation, outline the task, prerequisites, steps, and troubleshooting. This skill generates guides with YAML frontmatter for name and description, plus a Markdown body with problem, features, and Quick Start sections.

What is the best way to standardize workflows and step-by-step guides across projects?

Standardizing workflows requires a repeatable structure for documenting procedures. This skill provides a template with YAML frontmatter and Markdown sections to capture steps, prerequisites, and troubleshooting for reuse across teams.

Does this documentation format require YAML frontmatter and Markdown?

Yes, this documentation format requires YAML frontmatter with a name and description, along with a Markdown body. The Markdown body must include dedicated sections for the problem, features, and a one-sentence Quick Start.

Can I use this approach to capture procedures and reduce onboarding time?

Yes, you can use this approach to capture procedures and reduce onboarding time. By documenting decisions, steps, prerequisites, and troubleshooting in a standardized format, teams can consistently follow and reuse the guidance.

What sections should a how-to guide include for troubleshooting and features?

A how-to guide should include sections for the problem, features, and a one-sentence Quick Start. The Markdown body also captures prerequisites, step-by-step instructions, and troubleshooting to reduce errors.