product-user-doc

What problem does it solve?

Produces clear, actionable product documentation and onboarding guides for end users, removing ambiguity about installation, first-use flows, and basic troubleshooting so nontechnical users can get started independently.

Core Features & Use Cases

• Cross-platform installation guidance: Separate, practical instructions for Linux, macOS, and Windows with pre-requisites and validation steps.
• First-run and onboarding flow: Step-by-step walkthrough from install to a first successful result, including expected outcomes after each step.
• Examples and troubleshooting: Concrete usage examples and a catalog of common errors with recovery steps and when to escalate.
• Repository-aware output: Investigates README, CLI commands, and project artifacts to avoid inventing commands and to align docs with the actual project.
• Deliverable structure and quality checklist: Produces a recommended file layout and verifies coverage for mandatory documents.

Quick Start

Ask the assistant to generate a complete user documentation set including README, installation guides for Linux/macOS/Windows, a guided first-steps walkthrough, usage examples, and a troubleshooting file using the repository sources as authoritative references.