用途:整理 API 文档与开发者门户的设计要点,覆盖文档结构、API 参考、代码示例、设计原则和开发者体验,适合规划或评审开发者文档站点。
主要能力:文档结构建议包含快速入门(5 分钟内完成首次 API 调用)、认证说明(含可用示例)、可搜索的端点参考、多语言代码示例、错误码参考和变更日志(含迁移说明)。API 参考按方法加路径(如 GET /api/v1/users)、一句话描述、参数(名称、类型、必填/可选、说明)、可直接复制的请求示例、带字段注释的响应示例、各类错误响应和交互式控制台组织。代码示例至少覆盖 cURL、Python、JavaScript,要求完整可运行、带复制按钮、语法高亮并展示预期输出。
设计原则:默认深色模式,代码用等宽字体、正文用无衬线字体,左侧边栏导航加搜索,支持即时结果的全页搜索、带选择器的版本化文档(v1、v2)以及打印或导出 PDF。
开发者体验:注册到获取 API 密钥并发出首个请求控制在 5 分钟内,提供沙箱/测试环境、速率限制面板、状态页链接和支持渠道(GitHub issues、Discord、邮件)。
限制:资料未提供具体实现代码、工具链、托管平台、收费或价格信息,也未说明实际效果与适用规模,相关细节暂未提供。