mcpField
P
product-documentation

product-documentation

github.com/hack23Documents1364 installsUpdated today
Repository

About product-documentation

A skill for teams creating product documentation, covering user guides, release materials, and reference content. It defines writing and structure standards to keep documentation clear, audience-focused, and supported by examples and visuals.

Key features

  1. 01User guide coverage requirements
  2. 02Release and migration documentation
  3. 03Reference content specifications
  4. 04Clear, active, audience-aware writing
  5. 05Structured pages with examples and visuals

Use cases

  1. 01Planning a product documentation set
  2. 02Writing feature guides and troubleshooting help
  3. 03Preparing release notes and migration guides
  4. 04Documenting configuration and CLI commands

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/hack23/homepage --skill product-documentation

After installing, type/product-documentationin Claude Code to confirm it loaded.

Details

From the project README

Product Documentation Skill

Purpose

Ensures product documentation is clear, comprehensive, and user-focused, helping users understand features, solve problems, and get maximum value from products.

Rules

Documentation Types

User Guides (MUST HAVE):

  • Getting Started guide
  • Feature documentation
  • Troubleshooting guide
  • FAQ
  • Glossary

Release Documentation:

  • Release notes (new features, bug fixes, breaking changes)
  • Migration guides
  • Upgrade instructions
  • Deprecation notices

Reference Documentation:

  • Feature specifications
  • Configuration options
  • Keyboard shortcuts / CLI commands
  • System requirements
Writing Standards

MUST:

  • Use clear, concise language
  • Write for the target audience (technical level)
  • Use active voice ("Click Save" not "Save should be clicked")
  • Include visuals (screenshots, diagrams, videos)
  • Provide examples
  • Keep up-to-date with product

Structure:

# Feature Name

## Overview
[What it does and why it's useful]

## Prerequisites
[What users need before starting]

## How to Use
### Step 1: [Action]
[Detailed instructions with screenshots]

### Step 2: [Action]
[More instructions]

## Examples
[Real-world use cases]

## Troubleshooting
[Common problems and solutions]

## Related
[Links to related documentation]

Examples

Feature Documentation Template
# Email Notifications

## Overview
Receive automatic email alerts when important events occur in your account.

## Setting Up Notifications

1. Go to **Settings** → **Notifications**
2. Toggle the events you want to be notified about
3. Verify your email address
4. Click **Save Preferences**

## Available Notification Types

- **Security Alerts**: Login attempts, password changes
- **System Updates**: Maintenance windows, feature releases
- **Account Activity**: Billing changes, user additions

## Troubleshooting

**Problem**: Not receiving notifications  
**Solution**: Check spam folder, verify email address

## Related
- [Email Configuration](./email-config.md)
- [Security Settings](./security.md)

Related Policies

Related Documentation

Comments

Markdown supported