
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.
- Installs
- 752
- Last 24h
- —
- Trending rank
- —
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill user-guide-creation- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads user-guide-creation automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
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
FAQ
What does the user-guide-creation skill do?
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.
How do I install user-guide-creation?
Run npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill user-guide-creation in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/user-guide-creation/ (personal) or .claude/skills/user-guide-creation/ (project).
Which AI agents can use user-guide-creation?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is user-guide-creation safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains user-guide-creation?
It is published by aj-geddes in aj-geddes/useful-ai-prompts. It has 752 recorded installs.
More from aj-geddes/useful-ai-prompts
nodejs-express-server
aj-geddes/useful-ai-prompts
Build production-ready Express.js servers with middleware, authentication, routing, and database integration. Use when creating REST APIs, managing requests/responses, implementing middleware chains, and handling server logic.
code-review-analysis
aj-geddes/useful-ai-prompts
Perform comprehensive code reviews with best practices, security checks, and constructive feedback. Use when reviewing pull requests, analyzing code quality, checking for security vulnerabilities, or providing code improvement suggestions.
rest-api-design
aj-geddes/useful-ai-prompts
Design RESTful APIs following best practices for resource modeling, HTTP methods, status codes, versioning, and documentation. Use when creating new APIs, designing endpoints, or improving existing API architecture.
jenkins-pipeline
aj-geddes/useful-ai-prompts
Build Jenkins declarative and scripted pipelines with stages, agents, parameters, and plugins. Implement multi-branch pipelines and deployment automation.
architecture-diagrams
aj-geddes/useful-ai-prompts
Create system architecture diagrams using Mermaid, PlantUML, C4 model, flowcharts, and sequence diagrams. Use when documenting architecture, system design, data flows, or technical workflows.
ansible-automation
aj-geddes/useful-ai-prompts
Infrastructure automation and configuration management using Ansible playbooks, roles, and inventory. Use for deploying applications, patching, and managing servers.
Popular docs & writing skills
grill-with-docs
mattpocock/skills
A relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.
lark-markdown
open.feishu.cn
飞书 Markdown:查看、创建、上传、编辑和比较飞书中的原生 Markdown 文件。当用户要操作飞书 Markdown 文件,或比较其远端版本及本地草稿时使用。纯本地 Markdown 文件操作不触发本 skill。不负责将 Markdown 导入为飞书在线文档,也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。
writing-beats
mattpocock/skills
Writing, exploit; assemble raw material into a journey of beats, grounding each term before a beat leans on it.
writing-shape
mattpocock/skills
Writing, exploit: shape raw material into an article, paragraph by paragraph.
writing-fragments
mattpocock/skills
Writing, explore: mine raw fragments, no structure yet.
writing-for-agents
mattpocock/skills
Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.