SuperAPI AI 工具集

handbook-backend-development

编程与开发

查看项目

更新于 10-16 03:44

技能介绍

用途:该技能用于在 Polar Handbook 的“Backend Development”栏目中新增条目。这类条目面向 Polar 开发者,用来解释后端开发相关的概念、工具与最佳实践。使用者需先说明想解释的概念,技能会引导完成文件创建、代码库探索与内容撰写。

主要流程与用法:第一步创建文件,在 handbook/backend-development 下新建一个能反映概念的 MDX 文件(例如解释分布式锁机制可命名为 distributed-lock.mdx)。文件模板包含 frontmatter 的 title 与 description,正文按“概念摘要”“何时使用该概念”“如何使用该概念”“其工作原理”组织;后三节分别说明适用场景、实践用法,以及底层技术细节并引用代码库。随后在 handbook/docs.json 的“Backend Development”下添加条目以纳入导航。

第二步探索代码库,查找与概念相关的信息,用准确、详细的内容填充各节,也可加入代码片段、图表等有助于说明的内容。第三步请用户对草稿反馈,若有疑问则请求澄清,也可就结构与清晰度征求意见,确保条目准确、清晰、对 Polar 开发者有用。

适用场景:为 Polar 后端团队沉淀概念说明、工具介绍和最佳实践文档。限制:资料未提供该技能的安装命令、平台支持、收费方式或效果数据;具体文件命名与内容质量依赖对 Polar 代码库的探索。