編集方針

Evidence

Published: 2026-05-22
Updated: 2026-05-22
Reviewed: 2026-05-22 16d ago
Freshness: fresh

About で示した 3 つのペインに対応するため、以下の規約を厳密に運用します。

1. 三層タイムスタンプ

全ページの frontmatter に以下を含める。

publishedAt: 2026-05-22    # 初回公開日（変更しない）
updatedAt: 2026-05-22      # 修正のたびに更新（typo 修正も含む）
lastReviewedAt: 2026-05-22 # 本文の主張が一次情報と一致することを最後に確認した日

lastReviewedAt の運用基準:

経過日数	表示	アクション
0–90 日	green	OK
91–180 日	yellow stale 警告	次の更新サイクルで再確認
181 日〜	red 警告	引用前に必ず一次情報で再検証

ページ冒頭に <PageMeta /> コンポーネントを置くことで、上記表示を自動化する。

2. 出典トレーサビリティ

frontmatter

sources:
  - url: https://docs.anthropic.com/en/api/messages
    title: Anthropic Messages API
    fetchedAt: 2026-05-22
  - https://platform.openai.com/docs/api-reference/chat/create  # 短縮形も可

本文中の出典明示

重要な主張は脚注番号で出典を紐付ける（MDX の footnote 構文を使う）。

実測情報の扱い

実測した情報には Measured バッジ を付け、測定条件を併記する。

<span class="verify-badge" data-verify="measured">Measured</span>

- モデル: `claude-opus-4-7`
- SDK: `@anthropic-ai/sdk@0.40.0`
- 測定日: 2026-05-22
- 試行回数: 100
- 結果: ...

不明点の扱い

公式 doc にない、かつ実測もしていない事項は unverified を明示 する。推測で断定しない。

:::caution[unverified]
レート制限の具体的な数値はドキュメントに記載がなく、実測でも確認できていない。
:::

3. 完全網羅マトリクス

各セクション (providers/, parameters/, compare/) の index.mdx に、 まだ書いていないトピックも含めた マトリクスを置く。

書いた記事は通常リンク
未着手は灰色テキスト + 準備中 ラベル

これにより、「このトピックの情報が無い」ことを利用者がすぐ判断できる。

3.5 curl First — HTTP を真実とする

LLM API の挙動を語る記事は、SDK ではなく HTTP（curl）を一次表現とする。SDK は言語ごとに抽象化が異なり、バージョン差で挙動が動くため、長期保守性と他言語移植のしやすさの両面で不利になる。SDK 例は curl 例の補助として併記する。

changelog 記事の必須セクション

severity: breaking または minor の記事は次のセクションを必ず含める。

要約（1〜2 段落、結論ベース）
Before / After の curl 実例 — 同一リクエストを旧 API・新 API に投げ、レスポンス差分を提示
JSON schema / status code の差分 — diff コードブロックで明示
壊れる条件 — どの呼び出しパターンが具体的に失敗するか
影響対象 — 利用者像（SDK バージョン、リージョン、認証方式など）
移行手順 — 最小変更でアップグレードする手順、diff コードブロック推奨
検証ポイント — マージ前に確認すべき項目チェックリスト

severity: info の記事は 1, 2, 7 のみで構いません。

Verified バッジ

curl で再現確認した記事には Verified バッジ を付与する。これは「公式 doc を読んだだけ」ではなく、実際に API に投げて確認したことを示す。

<span class="verify-badge" data-verify="verified">Verified</span>

- 確認日: 2026-05-22
- エンドポイント: `POST https://api.anthropic.com/v1/messages`
- 確認内容: 旧フィールドが 400 を返すこと、新フィールドで成功すること

Measured バッジ（実測情報の扱い）との違い:

バッジ	用途
`Verified`	curl で API 挙動を再現確認した（仕様の確認）
`Measured`	パラメータ等の挙動を統計的に測定した（出力の測定）
`unverified`	公式 doc にも記載がなく、実測もしていない

4. severity 判定基準（changelog 記事）

severity	条件
`breaking`	パラメータ削除、レスポンス形式変更、エンドポイント廃止、認証方式の破壊的変更
`minor`	デフォルト値変更、新エラーコード追加、レート制限変更
`info`	機能追加、モデル追加、価格改定、ドキュメント整備

迷ったら breaking 寄りに倒す（利用者目線で安全側）。

5. ファイル命名

changelog: changelogs/YYYY-MM-<provider>-<slug>.mdx
パラメータ: parameters/<param-name>.mdx（snake_case でなく kebab-case）
プロバイダ: providers/<provider-name>.mdx
モデル: providers/<provider>/models/<model-id>.mdx
比較: compare/<topic>.mdx

6. スタイル規約

装飾画像・emoji・煽り表現を使わない
本文はテキスト密度を最大化し、表とリストを多用する
各記事の冒頭で「結論 / 対象読者 / 前提条件」を示す
末尾に「関連記事」リンクを置く

7. 多言語対応

root（日本語）と en/ 両方を更新するのが理想
英語側が遅れる場合は OK。ただし英語の en/ には日本語の本文を残さない
リンクは locale-aware に: [ja](/providers/anthropic/) / [en](/en/providers/anthropic/)