コンテンツにスキップ

ドキュメントに貢献する

ドキュメントは Markdown または MDX で管理し、pull request でレビューします。

  • 読者の目的から始めます。
  • 1 ページでは 1 つのタスクまたは主要な概念を扱います。
  • Admin 画面と同じメニュー名・ラベルを使用します。
  • コマンド名、API、フィールド名、画面上のラベルは原文のまま記載します。一般的な技術用語は「プラグイン」「テーマ」「ランタイム」のようにカタカナで表記し、通常の説明文に英単語を混在させないでください。
  • 英文の語順をそのまま写さず、自然で簡潔な日本語に書き直します。
  • ページに記載されたバージョンで例が動作することを確認します。
  • 実際のシークレット、認証情報、顧客データを例に含めません。
  • 製品の動作を変更する場合は、同じ pull request でドキュメントも更新します。
---
title: 明確なタイトル
description: 読者が達成できることを説明する一文。
---

言語を切り替えたときに対応するページへ移動できるよう、すべての言語で同じ相対パスを使用してください。