user-guide-writing

Create structured Markdown user guides with sections and screenshots.

40|9|Updated Jan 4, 2026
One-click install
npx skills add https://github.com/akillness/oh-my-skills --skill user-guide-writing-akillness
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: user-guide-writing
Source: https://github.com/akillness/oh-my-skills/tree/main/.agent-skills/user-guide-writing
Command: npx skills add https://github.com/akillness/oh-my-skills --skill user-guide-writing-akillness

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Write clear, user-focused guides, onboarding docs, how-to tutorials, and FAQs to help end users understand and use products effectively.

Core Features & Use Cases

  • Produces onboarding guides, step-by-step tutorials, and FAQs tailored for end users.
  • Delivers guides with plain language, logical structure, and visual aids (screenshots) to enhance comprehension.
  • Use Case: Create a complete user guide for a new feature, including a quick-start section and troubleshooting tips.

Quick Start

Generate a complete user guide for a given feature, including recommended screenshots and a step-by-step workflow.

Frequently Asked Questions about user-guide-writing

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

FAQPage Schema
How do I write a user guide for a new product feature?

To write a user guide for a new product feature, structure your content into onboarding flows, feature explanations, and troubleshooting tips using structured Markdown with consistent formatting. The output includes plain language step-by-step tutorials and recommended screenshot placements ready for publication.

What is the best way to create onboarding documentation that is easy to follow?

The best way to create onboarding documentation is to use plain language, logical structure, and visual aids like screenshots to enhance comprehension. It delivers end-user guides and tutorials that clearly explain product features and resolve common problems.

Does this approach to guide-writing support generating FAQs and troubleshooting sections?

Yes, this approach to guide-writing supports generating FAQs and troubleshooting sections tailored for end users. It creates complete documentation including quick-start sections and common problem resolutions ready for publication.

Can I use Markdown to format how-to tutorials and include screenshots?

You can use Markdown to format how-to tutorials by producing structured output with sections and consistent formatting. The generated guides explicitly include recommendations for visual aids like screenshots where appropriate to improve reader comprehension.

When do I need to generate a quick-start section for my product documentation?

You need a quick-start section for product documentation when creating a complete user guide for a new feature. It structures the onboarding workflow and feature explanations into clear, plain language end-user tutorials ready for publication.