api-page-generator

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Pages: API Introduction

页面：API介绍

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.

本指南用于指导搭建通常位于

/api

路径的API介绍页，该页面用于概述API功能、使用场景，并提供文档跳转链接。API文档（端点参考、代码示例）需放在独立页面中。

调用规则：首次使用时，如果适用，可以先用1-2句话说明本技能覆盖的范围以及实用价值，再提供核心输出。如果是后续调用或者用户要求跳过说明，则直接输出核心内容。

Initial Assessment

初步评估

Check for project context first: If

.claude/project-context.md

.cursor/project-context.md

exists, read it for product and developer use cases.

Identify:

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

优先检查项目上下文：如果存在

.claude/project-context.md

或

.cursor/project-context.md

文件，先读取文件内容了解产品和开发者使用场景。

明确以下信息：

API类型：REST、GraphQL等
目标受众：开发者（集成使用） vs 决策者（评估选型）
文档位置：API文档的存放地址（例如
```
/docs
```
、
```
/api/reference
```
、外部站点等）

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

API页面（
```
/api
```
）：包含介绍、概览、价值主张、指向文档或注册页的CTA
API文档：存放在文档站点（docs.*）的API参考板块，包含端点参考、鉴权说明、示例代码

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

API功能说明：清晰的价值主张、核心能力
使用场景：适用人群、常见使用场景
快速入门：引导用户快速发起首次调用或跳转文档的最短路径
文档跳转入口：醒目的指向API文档的CTA

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

核心概念：仅提供高层级说明，不要展示端点级的细节
鉴权概述：说明鉴权的工作逻辑，详细内容跳转文档查看
定价/使用限制：如果对选型评估有影响则需展示
SDK与工具：如果有提供则展示，跳转文档查看详情

SEO and Discovery

SEO与曝光

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

开发者搜索优化： targeting「API」+ 产品/品类相关关键词
元数据：适配开发者搜索意图的标题、描述
内部链接：从首页、功能页、资源页添加指向本页面的内部链接