user-guide

Design and document a user guide with structured process, quality checks, and system integration

SKILL.md

GitHub

User Guide

Purpose

Design and document a comprehensive user guide that delivers actionable, measurable results. This skill provides a structured process with quality validation, ensuring professional-grade output every time.

Category: Content & Copywriting

Inputs

Required

  • Objective: What you want to achieve with this deliverable
  • Target Audience: Who this is for (demographics, psychographics, pain points)

Optional

  • Brand Voice: Tone and style guidelines (check knowledge-base for existing)
  • Competitors: Key competitors to differentiate from

System Context

Before starting:

  • Read memory.md for current project context and priorities
  • Check knowledge-base.md for relevant learned rules or constraints
  • Review any existing related documents in the project
  • Note any active tasks in Task Board.md that relate to this deliverable

Process

Step 1: Context & Research

  • Review any existing user guide documents in the project
  • Check knowledge-base.md for relevant learned rules or constraints
  • Check memory.md for current project context and priorities
  • Identify key stakeholders and their requirements
  • Select the most appropriate framework: AIDA for copy, PAS (Problem-Agitate-Solve), BAB (Before-After-Bridge)

Step 2: Analysis & Framework Application

  • Apply the selected framework to structure the user guide
  • Identify gaps, opportunities, and risks
  • Define success metrics: Readability Score (Flesch-Kincaid 60+), Time on Page, Scroll Depth, Social Shares
  • Document assumptions and dependencies
  • Validate approach against industry best practices

Step 3: Build the Deliverable

  • Structure the user guide using the output format below
  • Include specific, actionable recommendations — not generic advice
  • Add concrete numbers, timelines, and benchmarks where applicable
  • Cross-reference with existing project documents for consistency
  • Ensure every section adds value — remove filler

Step 4: Quality Validation

  • All required inputs have been addressed
  • Recommendations are specific and actionable (not vague)
  • Numbers and benchmarks are realistic and sourced
  • Output format matches the specification below
  • No contradictions with knowledge-base rules
  • Follows best practice: Write at 8th grade reading level for general audiences

Output Format

# User Guide

## Executive Summary
[2-3 sentence overview of the deliverable and key recommendations]

## Context & Objectives
- **Objective**: [What this achieves]
- **Audience**: [Who this is for]
- **Timeline**: [When this applies]

## Analysis
[Structured analysis using the selected framework]

## Recommendations
1. [Specific, actionable recommendation with expected impact]
2. [Specific, actionable recommendation with expected impact]
3. [Specific, actionable recommendation with expected impact]

## Implementation
| Action | Owner | Timeline | Priority |
|--------|-------|----------|----------|
| [Action item] | [Who] | [When] | [High/Medium/Low] |

## Success Metrics
| Metric | Current | Target | Measurement Method |
|--------|---------|--------|-------------------|
| [KPI] | [Baseline] | [Goal] | [How to measure] |

## Risks & Mitigations
| Risk | Likelihood | Impact | Mitigation |
|------|-----------|--------|------------|
| [Risk] | [H/M/L] | [H/M/L] | [Action] |

## Next Steps
- [ ] [Immediate next action]
- [ ] [Follow-up action]
- [ ] [Review date]

Applicable Frameworks

  • AIDA for copy
  • PAS (Problem-Agitate-Solve)
  • BAB (Before-After-Bridge)
  • Inverted Pyramid
  • Hub and Spoke content model
  • Content Atomization
  • StoryBrand

Key Metrics

  • Readability Score (Flesch-Kincaid 60+)
  • Time on Page
  • Scroll Depth
  • Social Shares
  • Backlinks Generated
  • Conversion Rate from Content

Best Practices

  • Write at 8th grade reading level for general audiences
  • One idea per paragraph, max 3 sentences
  • Front-load the value — answer the question in the first 100 words
  • Use active voice (90%+ of sentences)
  • Every piece needs a clear CTA

After Completion

  • Update memory.md if this deliverable changes project context or priorities
  • Add any reusable learnings to knowledge-nominations.md
  • If follow-up actions were identified, add them to Task Board.md
  • Recommend related skills if additional work is needed