mcpField
H
handbook-backend-development

handbook-backend-development

github.com/polarsource开发10.4k40 次安装今天更新
代码仓库

关于 handbook-backend-development

指导 Polar 开发者为 Handbook 的“Backend Development”部分编写新条目。它引导用户探索代码库、按指定结构撰写内容,并将页面加入导航。

主要功能

  1. 01创建并命名 MDX 条目文件
  2. 02按三部分结构组织技术内容
  3. 03探索代码库以收集准确信息
  4. 04将新页面加入 Handbook 导航
  5. 05通过反馈完善草稿

适用场景

  1. 01记录后端概念的工作原理
  2. 02撰写后端工具或最佳实践文档
  3. 03为 Handbook 添加新条目

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/polarsource/polar --skill handbook-backend-development

安装后在 Claude Code 中输入/handbook-backend-development确认已加载。

详细介绍

手册 - 后端开发

这项技能介绍了如何在 Polar 手册的“后端开发”部分新增条目。这些条目用于介绍与后端开发相关的概念、工具和最佳实践,供 Polar 开发者阅读。

用户应说明想在新条目中介绍哪个概念,本技能将引导用户完成创建文件、探索代码库以查找相关信息,以及撰写条目内容的过程。

第 1 步:创建文件

在 handbook/backend-development 中创建一个 MDX 文件,并使用能体现所要介绍概念的名称。例如,如果想介绍分布式锁机制的工作原理,可以将文件命名为 distributed-lock.mdx。

请按照以下模板编写文件内容:

---
title: "Title of the entry"
description: "Short description of the entry"
---

Summary of the concept you want to explain.

## When to use this concept

## How to use this concept

## How it works

“何时使用此概念”“如何使用此概念”和“底层工作原理”这三个部分用于组织条目内容。第一部分应说明该概念适用于哪些场景,第二部分应说明如何在实践中使用该概念,第三部分应介绍该概念的底层工作原理,并提供技术细节和代码库参考。

在 handbook/docs.json 中“后端开发”下添加一项,将此页面加入导航。

第 2 步:探索并起草条目内容

要撰写条目内容,你需要探索代码库,查找与要介绍的概念相关的信息。利用这些信息,为条目的三个部分补充准确、详细的内容。你还可以添加代码片段、图表或任何其他有助于解释该概念的内容。

第 3 步:征求反馈

完成条目初稿后,请向用户征求反馈。如果对内容有任何疑问,请请求用户澄清。你也可以就条目的结构和清晰度征求反馈。目标是确保条目准确、清晰,并对 Polar 开发者有所帮助。

评论

支持 Markdown