Back to list
spjoshis

user-guide-writing

by spjoshis

Modular Claude plugins for agent-based expertise and reusable skills across software development and Agile. Easily extend, share, and automate best practices for modern development.

1🍴 0📅 Dec 30, 2025

SKILL.md


name: user-guide-writing description: Master user guide writing with clear instructions, tutorials, screenshots, and end-user documentation.

User Guide Writing

Create clear, user-friendly guides that help end-users understand and effectively use your product.

When to Use This Skill

  • Onboarding new users
  • Feature documentation
  • Step-by-step tutorials
  • Troubleshooting guides
  • FAQ creation
  • Release documentation
  • Training materials
  • Quick start guides

Core Concepts

1. Getting Started Guide

# Getting Started with ProductName

## Create Your Account

1. Go to https://product.com/signup
2. Enter your email address
3. Choose a strong password
4. Click "Create Account"
5. Check your email for verification link

**Tip**: Use a work email for team collaboration features.

## Set Up Your First Project

1. Click "+ New Project" in the dashboard
2. Enter project name and description
3. Choose a template or start blank
4. Click "Create"

**Screenshot**: [Dashboard with New Project button highlighted]

## Invite Your Team

1. Open your project
2. Click "Settings" → "Team"
3. Enter team member emails
4. Select their role (Admin, Member, Viewer)
5. Click "Send Invitations"

**Next Steps**: Learn how to [create tasks](#) and [set up workflows](#).

2. Tutorial Structure

# How to Create a Dashboard

**What you'll learn**: Create custom dashboards to visualize your data.

**Time**: 10 minutes
**Difficulty**: Beginner

## Prerequisites

- Active account
- At least one data source connected

## Steps

### Step 1: Create Dashboard

Navigate to Dashboards and click "+ New Dashboard".

[Screenshot]

### Step 2: Add Widgets

Click "Add Widget" and select chart type:
- Line chart for trends
- Bar chart for comparisons
- Pie chart for distributions

[Screenshot with widget options]

### Step 3: Configure Data

1. Select data source
2. Choose metrics
3. Set time range
4. Apply filters (optional)

[Screenshot of configuration panel]

### Step 4: Customize Appearance

- Change colors in the "Style" tab
- Add title and description
- Adjust chart size

### Step 5: Save and Share

Click "Save" and optionally "Share" to generate public link.

## You Did It!

Your dashboard is ready. Try adding more widgets to create a comprehensive view.

**Related**: [Advanced Dashboard Features](#), [Data Sources Guide](#)

Best Practices

  1. Task-oriented - Focus on what users want to accomplish
  2. Clear steps - Numbered, sequential instructions
  3. Visual aids - Screenshots, diagrams, videos
  4. Plain language - Avoid technical jargon
  5. Test instructions - Follow your own steps
  6. Provide context - Explain why, not just how
  7. Link related content - Help users discover more
  8. Keep updated - Maintain accuracy with product changes

Resources

  • Style guides: Google Developer Documentation Style Guide
  • Screenshot tools: Snagit, CloudApp, Loom for videos

Score

Total Score

60/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

0/10
説明文

100文字以上の説明がある

+10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新

+5
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

0/5
タグ

1つ以上のタグが設定されている

+5

Reviews

💬

Reviews coming soon