docs-page-generator
When the user wants to create, optimize, or structure a documentation site. Also use when the user mentions "docs," "documentation site," "docs subdomain," "docs.yourdomain.com," "help center," "knowledge base," "Getting Started," "API Reference," "user guides," or "tutorials." For API marketing landing, use api-page-generator.
Best use case
docs-page-generator is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
When the user wants to create, optimize, or structure a documentation site. Also use when the user mentions "docs," "documentation site," "docs subdomain," "docs.yourdomain.com," "help center," "knowledge base," "Getting Started," "API Reference," "user guides," or "tutorials." For API marketing landing, use api-page-generator.
Teams using docs-page-generator should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/docs/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How docs-page-generator Compares
| Feature / Agent | docs-page-generator | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
When the user wants to create, optimize, or structure a documentation site. Also use when the user mentions "docs," "documentation site," "docs subdomain," "docs.yourdomain.com," "help center," "knowledge base," "Getting Started," "API Reference," "user guides," or "tutorials." For API marketing landing, use api-page-generator.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# Pages: Documentation Site Guides documentation site structure, navigation, and content organization. Typically hosted on `docs.*` or `help.*` subdomain. Includes Getting Started, guides, tutorials, **API Reference** (endpoint docs), and troubleshooting. Distinct from API introduction page (api-page-generator). **When invoking**: On **first use**, if helpful, open with 1–2 sentences on what this skill covers and why it matters, then provide the main output. On **subsequent use** or when the user asks to skip, go directly to the main output. ## Initial Assessment **Check for project context first:** If `.claude/project-context.md` or `.cursor/project-context.md` exists, read it for product, audience, and use cases. Identify: 1. **Product type**: Software, API, hardware, service 2. **Audience**: End users, developers, admins 3. **Content sources**: Markdown, MDX, Git, CMS 4. **Subdomain**: docs.*, help.*, or path (/docs) ## Documentation Structure | Section | Purpose | Typical Content | |---------|---------|-----------------| | **Getting Started** | Onboarding, first steps | Quick start, installation, first task | | **Guides / Tutorials** | Step-by-step learning | How-to articles, workflows | | **Concepts** | Background, architecture | Key concepts, glossary links | | **API Reference** | Endpoint docs | Auth, request/response, examples; part of docs, not separate page | | **Troubleshooting** | Problem solving | FAQ, common errors, support links | ## Best Practices ### Information Architecture - **Progressive disclosure**: Start simple, link to depth - **Sidebar navigation**: Hierarchical, collapsible sections - **Search**: Full-text search for long doc sets - **Breadcrumbs**: For deep hierarchies ### API Reference (within Docs) API Reference is a section of docs, not a standalone page. Include: endpoints by resource, auth, request/response schemas, error codes, rate limits, code examples (cURL, SDKs). Use OpenAPI/Swagger for consistency. ### Content - **Task-oriented**: "How to X" not "X feature" - **Code examples**: Copy-paste ready, multiple languages if relevant - **Screenshots/videos**: For UI-heavy products - **Versioning**: Document product/API version when applicable ### SEO and Discovery - **Index docs**: Unless internal-only; use robots if needed - **Internal links**: Cross-link related articles, link to main site - **Schema**: TechArticle, HowTo for guides ## Output Format - **Structure** (sections, hierarchy) - **Navigation** design (sidebar, top-level) - **Getting Started** outline - **Content** checklist per section - **Subdomain/path** recommendation ## Related Skills - **api-page-generator**: API intro page links to docs - **sidebar-generator**: Docs sidebar design - **faq-page-generator**: FAQ can live in docs or main site - **howto-section-generator**: HowTo step blocks in guides/tutorials; TechArticle + HowTo alignment - **content-strategy**: Doc content planning
Related Skills
page-metadata
When the user wants to optimize meta tags other than title, description, Open Graph, or Twitter Cards. Also use when the user mentions "hreflang," "meta robots," "viewport," "charset," "canonical meta," "other meta tags," "meta robots noindex," "meta robots nofollow," "hreflang tags," "viewport meta," or "meta charset." For title tags, use title-tag. For meta descriptions, use meta-description. For Facebook/LinkedIn previews, use open-graph. For X previews, use twitter-cards.
status-page-generator
When the user wants to create, optimize, or structure a status page. Also use when the user mentions "status page," "status.yourdomain.com," "uptime," "service health," "incident page," or "system status." For incident comms, use public-relations.
signup-login-page-generator
When the user wants to create, optimize, or audit signup and login pages. Also use when the user mentions "signup page," "login page," "registration page," "auth page," "sign up form," "create account," "student discount at signup," or "auth subdomain." For indexing/auth URLs, use indexing.
feedback-page-generator
When the user wants to create, optimize, or audit a feedback or roadmap page. Also use when the user mentions "feedback page," "roadmap," "feature requests," "vote on features," "Canny," "UserVoice," or "product feedback." For sitewide page planning, use website-structure.
disclosure-page-generator
When the user wants to create, optimize, or audit an affiliate, sponsor, or paid partnership disclosure page. Also use when the user mentions "disclosure," "affiliate disclosure," "sponsored content," "FTC disclosure," or "paid partnership." For sitewide page planning, use website-structure.
changelog-page-generator
When the user wants to create, optimize, or structure a changelog or release notes page. Also use when the user mentions "changelog," "release notes," "what's new," "updates," "product updates," "version history," or "changelog.yourdomain.com." For sitewide page planning, use website-structure.
use-cases-page-generator
When the user wants to create, optimize, or audit use case pages. Also use when the user mentions "use cases," "use case page," "for [role]," "by persona," "by scenario," "by business goal," "ICP pages," or "audience-specific pages." For sitewide page planning, use website-structure.
startups-page-generator
When the user wants to create, optimize, or audit a startups, education, or special program page. Also use when the user mentions "startups program," "for startups," "education discount," "student plan," "for students," or "special pricing." For education discounts, use education-program.
solutions-page-generator
When the user wants to create, optimize, or audit solutions pages. Also use when the user mentions "solutions," "solutions page," "by industry," "industry solutions," "by company size," "SMB," "enterprise," "by outcome," "business outcomes," or "how we solve X." For sitewide page planning, use website-structure.
showcase-page-generator
When the user wants to create, optimize, or audit a showcase or gallery page for user-generated content. Also use when the user mentions "showcase," "gallery," "user work," "UGC," "creator showcase," "examples," or "made with [product]." For social proof components, use testimonials-generator.
services-page-generator
When the user wants to create, optimize, or audit a services page. Also use when the user mentions "services page," "what we offer," "service offerings," "consulting services," "service page," "offerings page," "service catalog," or "professional services." For sitewide page planning, use website-structure.
products-page-generator
When the user wants to create, optimize, or audit a product listing or category page. Also use when the user mentions "product page," "product listing," "shop," "e-commerce products," "product catalog," "product grid," "product cards," or "product overview." For category SEO, use category-page-generator.