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:
- Product type: Software, API, hardware, service
- Audience: End users, developers, admins
- Content sources: Markdown, MDX, Git, CMS
- 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
1---2name: docs-page-generator3description: 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.4---5
6# Pages: Documentation Site
7
8Guides 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).
9
10**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.
11
12## Initial Assessment
13
14**Check for project context first:** If `.claude/project-context.md` or `.cursor/project-context.md` exists, read it for product, audience, and use cases.
15
16Identify:
171. **Product type**: Software, API, hardware, service
182. **Audience**: End users, developers, admins
193. **Content sources**: Markdown, MDX, Git, CMS
204. **Subdomain**: docs.*, help.*, or path (/docs)
21
22## Documentation Structure
23
24| Section | Purpose | Typical Content |
25|---------|---------|-----------------|
26| **Getting Started** | Onboarding, first steps | Quick start, installation, first task |
27| **Guides / Tutorials** | Step-by-step learning | How-to articles, workflows |
28| **Concepts** | Background, architecture | Key concepts, glossary links |
29| **API Reference** | Endpoint docs | Auth, request/response, examples; part of docs, not separate page |
30| **Troubleshooting** | Problem solving | FAQ, common errors, support links |
31
32## Best Practices
33
34### Information Architecture
35
36- **Progressive disclosure**: Start simple, link to depth
37- **Sidebar navigation**: Hierarchical, collapsible sections
38- **Search**: Full-text search for long doc sets
39- **Breadcrumbs**: For deep hierarchies
40
41### API Reference (within Docs)
42
43API 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.
44
45### Content
46
47- **Task-oriented**: "How to X" not "X feature"
48- **Code examples**: Copy-paste ready, multiple languages if relevant
49- **Screenshots/videos**: For UI-heavy products
50- **Versioning**: Document product/API version when applicable
51
52### SEO and Discovery
53
54- **Index docs**: Unless internal-only; use robots if needed
55- **Internal links**: Cross-link related articles, link to main site
56- **Schema**: TechArticle, HowTo for guides
57
58## Output Format
59
60- **Structure** (sections, hierarchy)
61- **Navigation** design (sidebar, top-level)
62- **Getting Started** outline
63- **Content** checklist per section
64- **Subdomain/path** recommendation
65
66## Related Skills
67
68- **api-page-generator**: API intro page links to docs
69- **sidebar-generator**: Docs sidebar design
70- **faq-page-generator**: FAQ can live in docs or main site
71- **howto-section-generator**: HowTo step blocks in guides/tutorials; TechArticle + HowTo alignment
72- **content-strategy**: Doc content planning
kostja94