user-guide-writing
Create clear, user-focused documentation with step-by-step guides, screenshots, and FAQ sections.
- Generates four documentation types: quick-start guides, task-focused how-to articles, FAQ pages, and learning-focused tutorials
- Emphasizes visual clarity with embedded screenshots, GIFs, and structured numbered instructions designed for non-technical users
- Includes troubleshooting sections, related links, and multiple support contact methods to reduce user friction
- Follows plain-language principles, avoiding technical jargon and keeping explanations concise and scannable
User Guide Writing
When to use this skill
- New Features: Introduce new features to users
- Onboarding: Train new users
- FAQ: Organize frequently asked questions
Instructions
Step 1: Quick Start Guide
# Getting Started with MyApp
Welcome to MyApp! This guide will help you get up and running in 5 minutes.
More from supercent-io/skills-template
security-best-practices
Implement security best practices for web applications and infrastructure. Use when securing APIs, preventing common vulnerabilities, or implementing security policies. Handles HTTPS, CORS, XSS, SQL Injection, CSRF, rate limiting, and OWASP Top 10.
14.1Kdata-analysis
Analyze datasets to extract insights, identify patterns, and generate reports. Use when exploring data, creating visualizations, or performing statistical analysis. Handles CSV, JSON, SQL queries, and Python pandas operations.
13.8Kweb-accessibility
Implement web accessibility (a11y) standards following WCAG 2.1 guidelines. Use when building accessible UIs, fixing accessibility issues, or ensuring compliance with disability standards. Handles ARIA attributes, keyboard navigation, screen readers, semantic HTML, and accessibility testing.
12.7Kworkflow-automation
Automate repetitive development tasks and workflows. Use when creating build scripts, automating deployments, or setting up development workflows. Handles npm scripts, Makefile, GitHub Actions workflows, and task automation.
12.6Kcode-review
Conduct thorough, constructive code reviews for quality and security. Use when reviewing pull requests, checking code quality, identifying bugs, or auditing security. Handles best practices, SOLID principles, security vulnerabilities, performance analysis, and testing coverage.
12.5Kdatabase-schema-design
Design and optimize database schemas for SQL and NoSQL databases. Use when creating new databases, designing tables, defining relationships, indexing strategies, or database migrations. Handles PostgreSQL, MySQL, MongoDB, normalization, and performance optimization.
12.2K