user-guide-writing_skill

Overview

This skill writes clear, user-focused guides and tutorials for end users. It produces quick start guides, step-by-step how-tos, FAQs, and hands-on tutorials that include screenshots and concise steps. The goal is fast onboarding and reduced support requests.

How this skill works

I create short, scannable documents that combine numbered steps, visual aids, and simple language. Each guide includes a quick start, task-focused how-tos, troubleshooting tips, and an FAQ when needed. Outputs are organized into a docs structure with images and ready-to-publish markdown files.

When to use it

• Onboarding new users or features
• Creating quick start or 5-minute setup guides
• Documenting task-focused workflows (how-to)
• Building tutorials for learning-by-doing
• Writing or updating FAQ and troubleshooting pages

Best practices

• Always include at least one screenshot or GIF for visual guidance
• Use numbered steps for tasks and short sentences for each step
• Avoid jargon; write from the user's perspective
• Highlight expected outcomes and common errors
• Keep sections small and update docs after UI changes

Example use cases

• Getting Started guide for new users with account setup and first project
• How-to export data with step-by-step instructions and troubleshooting
• FAQ covering account, billing, compatibility, and security questions
• Tutorial to build a first dashboard with screenshots and time estimate
• Onboarding flow for a new feature showing where to click and what to expect