Agent skill · writing content · aj-geddes
user-guide-creation
Create comprehensive user guides, tutorials, how-to documentation, and step-by-step instructions with screenshots and examples. Use when writing user documentation, tutorials, or getting started guides.
Why this skill is useful
Codifies best practices for creating user documentation but AI already knows general writing principles.
What it needs
About 2k tokens when loaded. Last updated 2026-03-04. 307 stars on the source repository.
What this skill does
User Guide Creation Table of Contents Overview When to Use Quick Start Reference Guides Best Practices Overview Create clear, user-friendly documentation that helps users understand and effectively use your product, with step-by-step instructions, screenshots, and practical examples. When to Use Product user manuals Getting started guides Feature tutorials Step-by-step how-tos Video script documentation Interactive walkthroughs Quick start guides FAQ documentation Best practices guides Quick Start Minimal working example: Reference Guides Detailed implementations in the references/ directory: Guide Contents --- --- System Requirements System Requirements Installation Installation Initial Setup Initial Setup Task 1: Creating Your First Project Task 1: Creating Your First Project Task 2: Importing Existing Data Task 2: Importing Existing Data Task 3: Exporting Data Task 3: Exporting Data Best Practices ✅ DO Use simple, clear language Include screenshots and visuals Provide step-by-step instructions Use numbered lists for sequential tasks Add tips, warnings, and notes Include keyboard shortcuts Provide multiple paths to accomplish tasks Test every step you document Keep content up-to-date Use consistent formatting Add a table of contents for long guides Include search functionality ❌ DON'T Use jargon without explanation Assume prior knowledge Skip important steps Use outdated screenshots Write wall-of-text paragraphs Forget to update for new versions Overcomplicate simple tasks
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aj-geddes/user-guide-creation