product-docs

Generate stakeholder product overview and end-user guide HTML documents from project context.

1|Updated Jun 27, 2026
One-click install
npx skills add https://github.com/vickysrawat/AI-Assisted-development --skill product-docs-vickysrawat
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: product-docs
Source: https://github.com/vickysrawat/AI-Assisted-development/tree/main/skills/product-docs
Command: npx skills add https://github.com/vickysrawat/AI-Assisted-development --skill product-docs-vickysrawat

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Creating formal product documentation — a stakeholder-facing Product Detail Document and an end-user User Guide — is time-consuming and often skipped. This Skill generates both as polished, self-contained HTML files derived directly from the project's README, CLAUDE.md, and build files, so documentation reflects what actually exists in the codebase. ## Core Features & Use Cases - Product Detail Document: Stakeholder-facing HTML overview covering problem statement, target users, core features, user journeys, business rules, architecture diagram, environments, NFRs, success metrics, and future roadmap. - User Guide: Step-by-step end-user HTML instructions with prerequisites, core workflows, tips, troubleshooting, FAQ, and screenshot placeholders. - Consent-first generation: Always asks which documents to create before generating, and never documents features that are not present in the codebase. - Use Case: After finishing a project milestone, ask for a product overview and user guide; the Skill reads your README and project files, fills the HTML templates, and writes {project-name}-product-overview.html and {project-name}-user-guide.html to the project root. ## Quick Start Ask the assistant to generate a product detail document and user guide for this project, then confirm which of the two documents you want when prompted.

Frequently Asked Questions about product-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a product overview document for my project?

Ask the assistant to generate a product detail document. The Skill reads your README, CLAUDE.md, and project files, fills the product-detail HTML template with real project data, and writes a self-contained HTML file to the project root.

How to create an end-user guide from an existing codebase?

Request a user guide and confirm when prompted. The Skill extracts workflows and features from project sources, populates the user-guide HTML template with steps, tips, and FAQ, and outputs a browser-ready HTML file with screenshot placeholders.

Does the generated documentation require external CSS or JS files?

No. Both templates are fully self-contained HTML files with all CSS inline. The Skill explicitly avoids adding external CDN links, so the output opens in any browser without dependencies.

What happens if my project has no README or CLAUDE.md?

If critical context is missing, the Skill asks you directly for the project name, one-line description, primary tech stack, and up to five key features before generating anything. It never fabricates features that are not in the codebase.

Can I generate only one of the two documents?

Yes. The Skill always asks first whether you want both documents, only the Product Detail Document, or only the User Guide, and it never generates a document you declined.