User guide creation
Skill ulpi-io/plugin-marketplace/plugins/aj-geddes/skills/user-guide-creation
A curated collection of 7,800+ agent skills for Claude Desktop, sourced from skills.sh
npx -y skills add ulpi-io/plugin-marketplace --skill user-guide-creationAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
- 1 stars1 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
What its author says it does
Copied from the file, not written here
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.
SKILL.md
2.8 KB, as published. Nobody here has run it
User Guide Creation
Table of Contents
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:
# [Product Name] User Guide
## Table of Contents
1. [Introduction](#introduction)
2. [Getting Started](#getting-started)
3. [Key Features](#key-features)
4. [Common Tasks](#common-tasks)
5. [Troubleshooting](#troubleshooting)
6. [FAQ](#faq)
7. [Support](#support)
## Introduction
### What is [Product Name]?
[Product Name] is a [brief description of what the product does and its main purpose].
### Who is this guide for?
This guide is designed for:
- New users getting started with [Product Name]
- Existing users looking to learn advanced features
- Administrators managing [Product Name]
// ... (see reference guides for full implementation)
```
## Reference Guides
Detailed implementations in the `references/` directory:
| Guide | Contents |
|---|---|
| [System Requirements](references/system-requirements.md) | System Requirements |
| [Installation](references/installation.md) | Installation |
| [Initial Setup](references/initial-setup.md) | Initial Setup |
| [Task 1: Creating Your First Project](references/task-1-creating-your-first-project.md) | Task 1: Creating Your First Project |
| [Task 2: Importing Existing Data](references/task-2-importing-existing-data.md) | Task 2: Importing Existing Data |
| [Task 3: Exporting Data](references/task-3-exporting-data.md) | 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