メインコンテンツまでスキップ

コンテンツスタイルガイド

すべてのレベル

リファレンスに信頼感をもたらすのは一貫性です。これらに従えば、PR はレビューをすんなり通過します。

文体​

  • 明確かつ率直に。 短い文で。結論から書く。
  • 親しみやすく、決して冗長にしない。 「今日の変化の速い世界では」のような表現は削る。読者の時間を尊重する。
  • 主張を持ち、そして正直に。 まず推奨される唯一の方法を示し、次に代替案とトレードオフに触れる。
  • 理論より実例。 スニペットや具体的なケースを示す。説明だけで終わらせない。
  • アメリカ英語。

ページの構成​

---
sidebar_position: 2
title: "Your Page Title"
description: "One sentence for search and previews."
---

<LevelBadge level="beginner" />

A one or two sentence intro that states what the reader will get.

## Sections with ## headings
...

## Next
- 2–4 links to related pages
  • レベルバッジで始める（beginner | intermediate | advanced | all）。コンポーネントはグローバルです。インポートしないでください。
  • **「Next」／「Related」**の内部リンク 2〜4 個のリストで締めくくる。
  • アドモニション（:::tip、:::warning、:::note、:::info）を強調のために控えめに使う。

2つの厳格なルール​

:::warning 譲れない事項

  1. 変動しやすい事実には出典を引用する。 モデル名、価格、制限、正確なフラグ、ベータ機能 → 公式の出典をリンクし、<VerifyNote lastVerified="YYYY-MM-DD" source="…"> を追加します。モデルに関する事実をハードコードしない — モデルテーブルへリンクします。詳細: ファクト検証。
  2. 捏造しない。 でっち上げた統計、引用、API、機能は禁止。不確かな場合は、その旨を述べるか [verify] と印を付けます。 :::

意見 vs 公式情報​

  • 私たちは主張を持ちます — それが価値です。列挙するだけでなく、推奨します。
  • ただし公式ドキュメントが信頼できる情報源です。 それに従い、リンクし、決してひそかに矛盾させないでください。

MDX の落とし穴​

  • 本文中の波括弧 {like this} は MDX によってコードとして解釈されます。バックティックやコードフェンスで囲むか、例では [brackets] を使ってください。
  • ローカルでテストする: npm run build が通る必要があります（リンク切れがあると失敗します）。

次に読む​