docs

Name: docs
Author: kostja94

753stars109forks

How to install docs?

kostja94/marketing-skills/docs

$npx -y skills add kostja94/marketing-skills --skill docs

Installs into the current project.

Summary

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." F

Files · 1

View on GitHub

SKILL.md

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

People who liked this also viewed

6 picks

Type

docs

753stars109forks

View on GitHub

How to install docs?

kostja94/marketing-skills/docs

$npx -y skills add kostja94/marketing-skills --skill docs

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

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

People who liked this also viewed

6 picks

Type