# user-manual-generator

user-manual-generator generates deployment-ready end-user documentation sites from application source code. Useful when converting raw features into step-by-step guides for non-developers.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 2 installs
- Author: Mharbulous
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/Mharbulous/myskillium/tree/HEAD/.claude/skills/user-manual-generator/SKILL.md
- Updated: 2026-10-24
- Security check: automated, 2026-11-16 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/skills/user-manual-generator

## What it does

The skill inspects your repository to discover user-facing components, including web routes, CLI options, endpoints, and interface menus. Instead of producing internal API references, it formats the material according to the Diataxis standard: tutorials, how-to guides, technical references, and conceptual explanations. Output files are organized into static sites tailored for MkDocs Material, Docusaurus, VitePress, or standard Markdown.

Execution moves across seven strict stages, running from initial discovery through link verification and handoff tasks. Instructions load on demand from the `phases/` directory, preventing the model context from filling up prematurely.

This workflow focuses strictly on end-user enablement, meaning internal docstrings and standalone API definitions still require traditional tooling such as Sphinx or Swagger.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add Mharbulous/myskillium --skill user-manual-generator -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/user-manual-generator/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/user-manual-generator/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add Mharbulous/myskillium --skill user-manual-generator -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/user-manual-generator/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add Mharbulous/myskillium --skill user-manual-generator -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/user-manual-generator/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install Mharbulous/myskillium .claude/skills/user-manual-generator
```

2. **Manually: put the files in place**
- File: `.github/skills/user-manual-generator/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add Mharbulous/myskillium --skill user-manual-generator -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/Mharbulous/myskillium --path .claude/skills/user-manual-generator
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/user-manual-generator/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add Mharbulous/myskillium --skill user-manual-generator -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/Mharbulous/myskillium/tree/HEAD/.claude/skills/user-manual-generator/SKILL.md

## When to use it
- turn repository features into task-focused end-user manuals
- scaffold static documentation sites for VitePress, Docusaurus, or MkDocs
- organize application documentation using the Diataxis methodology
- validate links and verify code samples across generated docs

## Example prompts
- Analyze this codebase and generate an end-user guide configured for VitePress
- Create task-oriented how-to manuals and configuration docs following Diataxis
- Build a user manual site ready to deploy on GitHub Pages

## Similar
- [vitepress](https://affpapa.org/en/nevibecode/skills/vitepress.md) — skill · 12200 installs
- [documentation-expert](https://affpapa.org/en/nevibecode/agents/carlrannaberg-documentation-expert.md) — subagent · ★ 763 repo stars
- [agents-documentation](https://affpapa.org/en/nevibecode/plugins/agents-documentation.md) — plugin · ★ 3785 repo stars
- [page](https://affpapa.org/en/nevibecode/commands/page.md) — command · ★ 3232 repo stars
- [wiki-writer](https://affpapa.org/en/nevibecode/agents/wiki-writer.md) — subagent · ★ 3232 repo stars
- [user-guide-creation](https://affpapa.org/en/nevibecode/skills/user-guide-creation.md) — skill · 765 installs

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
