api-page-generator

$npx mdskill add kostja94/marketing-skills/api-page-generator

Creates, optimizes, or audits API introduction pages.

  • Solves user need for a compelling API overview page.
  • Depends on project context files for product and use cases.
  • Decides based on API type, audience, and docs location.
  • Delivers structured guidance and best practices for the page.

SKILL.md

.github/skills/api-page-generatorView on GitHub ↗
---
name: api-page-generator
description: 'When the user wants to create, optimize, or audit the API introduction/overview page. Also use when the user mentions "API page," "API landing page," "/api page," "API overview," "developer landing," "API marketing," or "API for developers." Note: API documentation (endpoint reference) lives in docs; use docs-page-generator.'
metadata:
  version: 1.0.1
---

# Pages: API Introduction

Guides the API introduction page →typically at `/api` →that overviews the API, use cases, and links to documentation. API documentation (endpoint reference, code examples) lives on separate pages.

**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 and developer use cases.

Identify:
1. **API type**: REST, GraphQL, etc.
2. **Audience**: Developers (integration) vs. decision makers (evaluation)
3. **Docs location**: Where API documentation lives (e.g. `/docs`, `/api/reference`, external)

## Page Role

- **API page** (`/api`): Introduction, overview, value prop, CTA to docs or signup
- **API documentation**: Lives in docs (docs.*) → API Reference section with endpoint reference, auth, examples

## Best Practices

### Overview and Structure

- **What the API does**: Clear value proposition, key capabilities
- **Use cases**: Who uses it, common scenarios
- **Getting started**: Quick path to first call or docs
- **Link to docs**: Prominent CTA to API documentation

### Content

- **Key concepts**: High-level, not endpoint-level detail
- **Auth overview**: How auth works; link to docs for details
- **Pricing/limits**: If relevant for evaluation
- **SDKs and tools**: If available; link to docs

### SEO and Discovery

- **Developer search**: Target "API" + product/category terms
- **Metadata**: Title, description for developer intent
- **Internal links**: From homepage, features, resources

## Output Format

- **Structure** outline (sections)
- **Value proposition** and key messages
- **CTA** to documentation or signup
- **SEO** metadata for developer search

## Related Skills

- **homepage-generator**: Link to API page for developers
- **schema-markup**: WebPage or SoftwareApplication schema
- **title-tag, meta-description, page-metadata**: API page metadata

More from kostja94/marketing-skills

SkillDescription
404-page-generatorWhen the user wants to create, optimize, or audit 404 error pages. Also use when the user mentions "404 page," "404 error," "error page," "page not found," "broken link page," "404 design," "custom 404," "404 redirect," "404 page UX," or "404 recovery." For sitewide page planning, use website-structure.
about-page-generatorWhen the user wants to create, optimize, or audit About page content. Also use when the user mentions "about page," "about us," "company story," "our team," "about section," "company overview," "brand story," "team page," or "who we are." For sitewide page planning, use website-structure.
affiliate-marketingWhen the user wants to plan, implement, or optimize affiliate marketing strategy. Also use when the user mentions "affiliate marketing," "affiliate program strategy," "CPS model," "affiliate recruitment," "commission structure," "affiliate partners," "affiliate network," "affiliate tracking," "affiliate commission," or "partner marketing." For affiliate page, use affiliate-page-generator.
affiliate-page-generatorWhen the user wants to create, optimize, or audit affiliate program page content. Also use when the user mentions "affiliate program," "affiliate page," "partner program," "referral program page," "affiliate landing," "partner landing," "commission page," or "affiliate signup." For affiliate program strategy, use affiliate-marketing.
ai-traffic-trackingWhen the user wants to track AI search traffic in GA4 or GSC. Also use when the user mentions "AI traffic," "ChatGPT referral," "Perplexity traffic," "AI Overviews," "GA4 AI sources," "AI search analytics," "track AI referrals," "AI search traffic," "Claude traffic," or "how to track AI traffic." For AI SEO strategy, use generative-engine-optimization.
alternatives-page-generatorWhen the user wants to create, optimize, or audit alternatives or comparison content (page or blog article). Also use when the user mentions "alternatives page," "alternatives listicle," "X alternatives," "competitor comparison," "vs page," "compare page," "best alternatives to X," "switch from X," "competitor brand traffic," "brand keyword ads," or "intercept competitor search." For competitor research, use competitor-research.
app-adsWhen the user wants to run app install ads, user acquisition (UA), or promote mobile apps. Also use when the user mentions "app ads," "app install ads," "UA," "user acquisition," "Google App Campaigns," "Apple Search Ads," "ASA," "UAC," "App Store ads," "Play Store ads," "CPI," or "app promotion." For store listings, use distribution-channels.
article-contentWhen the user wants to write, generate, or create article body content—blog post body, long-form content, how-to guide, listicle. Also use when the user mentions "write article," "article content," "blog post content," "article body," "long-form content creation," "generate article," "article draft," "how-to guide content," "listicle content," "information gain," or "content density." For single post page structure, schema, and SEO metadata, use article-page-generator. For blog index/listing page, use blog-page-generator. For short ad, landing, or email copy, use copywriting.
backlink-analysisWhen the user wants to analyze backlinks, audit link profile, or identify link issues. Also use when the user mentions "backlink analysis," "backlink audit," "referring domains," "toxic links," "link profile," or "disavow file." For acquisition, use link-building.
blog-page-generatorWhen the user wants to create, optimize, or audit blog index or listing page structure (not a single post). Also use when the user mentions "blog page," "blog index," "blog layout," "content hub," "blog homepage," "blog listing," "subdomain vs subdirectory," "blog structure," or "blog SEO." For single post page SEO and schema, use article-page-generator.