skills.rest
RorySullivan1
RorySullivan1COMMUNITY
Explore all skills by this author →
GitHub

user-guide-drafter

Generate end-user Markdown documentation with a four-section structure.

Updated May 12, 2026
Search Tags:#documentation#markdown#how-to#content-writing#end-user#tech-writing#user-guide
One-click install
npx skills add https://github.com/RorySullivan1/claudeBrain --skill user-guide-drafter
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: user-guide-drafter
Source: https://github.com/RorySullivan1/claudeBrain/tree/main/example-project/.claude/skills/user-guide-drafter
Command: npx skills add https://github.com/RorySullivan1/claudeBrain --skill user-guide-drafter

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams convert technical artifacts into clear, end-user documentation in Markdown, making complex projects accessible to non-technical readers.

Core Features & Use Cases

  • End-user documentation: generate consumer-focused guides (intents, usage steps, troubleshooting) from code, workflows, or projects.
  • Structure-first output: deliver guides with a consistent four-section layout (Intent, Quick Start, How-To, Troubleshooting) ready for publication.
  • Plain-language writing: rewrite technical details into approachable language with concrete examples.
  • Output formats: produce Markdown as the default, with optional formatting tweaks if requested.

Quick Start

Draft a complete user guide for the target project by providing a short description of the audience and the primary tasks they will perform.

Frequently Asked Questions about user-guide-drafter

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

FAQPage Schema
How do I convert a technical project into end-user documentation?▼

You can generate end-user documentation by providing a brief audience description and the primary tasks they perform. The tool outputs a structured Markdown guide covering Intent, Quick Start, How-To, and Troubleshooting sections for non-technical readers.

What is the best way to structure how-to guides for non-technical users?▼

The best way to structure how-to guides for non-technical users is a four-section Markdown layout: Intent, Quick Start, How-To, and Troubleshooting. This structure prioritizes plain language and task-first guidance to make technical workflows accessible.

Can I create Markdown documentation directly from existing workflows?▼

Yes, you can create Markdown documentation directly from existing workflows. The tool processes technical workflows and rewrites them into approachable language with concrete examples, outputting a consolidated guide ready for publication.

Does user guide generation include troubleshooting and recovery steps?▼

Yes, user guide generation includes troubleshooting and recovery steps. The produced Markdown documentation consistently features a dedicated Troubleshooting section to guide end-users on how to recover from issues.

What format does the documentation tool output by default?▼

The documentation tool outputs Markdown format by default. It generates consumer-focused guides with a consistent four-section layout in Markdown, with optional formatting tweaks available if specifically requested.

Related Skills

Explore More Content & Communication Skills→
yes506yes506

plan-establisher

Synthesize user intent and evidence into versioned Markdown and HTML project specifications.

Community
Advanced
saeed-vayghansaeed-vayghan
30

technical-writer

Develop API references, user guides, and tutorials for technical products.

Community
Advanced
zzafergokzzafergok
1

markdown-to-html-skill

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

Community
Intermediate
Cbanzaime23Cbanzaime23

bmad-agent-tech-writer

Generate structured technical documentation in Markdown, OpenAPI, and DITA formats.

Community
Advanced