Knowledge RAG
提交新原则设计知识库
由社区维护、审核后发布,并在 Agent 页面创作前被 RAG 检索为设计约束。
2 条已发布原则 / 全库 192 条
Frontend Implementationapi-reference / openapi
API Reference 端点页面契约
API 端点页应把 method/path、鉴权、参数、请求体、响应/错误矩阵、示例、try-it 安全和移动端 schema 阅读收敛成一个可执行文档契约。
API reference 不是把 OpenAPI schema 渲染出来就结束。它是开发者执行任务的操作面,必须同时服务发现、首次调用、鉴权配置、错误恢复、复制示例、试运行安全和版本信任。96%Frontend Implementationdeveloper-docs / code-block开发者文档代码示例与复制契约
开发者文档中的代码块不仅要高亮好看,还要说明任务、可安全复制、反馈清楚、tabs 可键盘操作、移动端不破坏页面滚动。
代码示例是产品操作面。它同时承担教学、配置、API 调用、信任和执行成本,因此必须把语法高亮、复制、占位符、tabs、playground、响应式和可访问反馈作为一套组件契约。96%