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

「この概念を使う場面」「この概念の使い方」「内部の仕組み」の 3 つのセクションは、項目の内容を構成するためのものです。最初のセクションでは、その概念がどのような状況で役立つかを説明します。2 つ目では、実際にその概念を使う方法を説明します。3 つ目では、技術的な詳細やコードベースへの参照を含め、内部の仕組みを説明します。

handbook/docs.json の「バックエンド開発」の下に項目を追加して、このページをナビゲーションに加えます。

ステップ 2：項目の内容を調査して草稿を作成する

項目の内容を執筆するには、説明する概念に関連する情報を見つけるために、コードベースを調査する必要があります。得られた情報を使って、項目の 3 つのセクションに正確かつ詳細な情報を記入してください。概念の説明に適していると思われる場合は、コードスニペット、図、その他のコンテンツを追加することもできます。

ステップ 3：フィードバックを求める

項目の草稿ができたら、ユーザーにフィードバックを求めてください。内容に不明点がある場合は、確認を求めてください。構成やわかりやすさについて、フィードバックを求めることもできます。目標は、その項目が正確で、明確で、Polar の開発者にとって有用であることを確認することです。