Skip to content

docs: ドキュメント全体の監査・多角的修正(3ラウンド)#104

Merged
hideyukiMORI merged 1 commit into
mainfrom
docs/doc-audit
May 19, 2026
Merged

docs: ドキュメント全体の監査・多角的修正(3ラウンド)#104
hideyukiMORI merged 1 commit into
mainfrom
docs/doc-audit

Conversation

@hideyukiMORI
Copy link
Copy Markdown
Owner

Summary

ドキュメント全体を「古い内容」「抜け」「多言語整合性」の3つの観点から3ラウンドの確認を経て修正。

Round 1 — 致命的な誤りと古いコマンド

  • configure-auth.md (EN/JA): BEARER_TOKENS/API_KEYS をカンマ区切りで記載していたのをJSON配列形式に修正(カンマ区切りは JSONDecodeError になる)
  • ja/reference/configuration.md: .env 例の CORS_ORIGINS/BEARER_TOKENS も同様に修正
  • design-philosophy.md (EN/JA): 削除済みの uv run export-openapiuv run python src/scripts/export_openapi.py に修正
  • 全6言語のテスト数を 167+ に統一(EN:165+、JA/DE/FR/ZH/PT-BR:135+ がそれぞれ古かった)
  • sqlalchemy-repository.md (EN): セクション番号 4→6 の飛びを修正・末尾の孤立```を削除
  • todo/current.md: v0.2.0 作業中の TODO リスト(全タスク未完のまま放置)を v1.x 完了後の状態に更新

Round 2 — 抜けと不整合

  • new-project.md (EN): BearerTokenMiddleware/ApiKeyAuthMiddleware/CORSMiddleware の import 文を追加(コード例がself-containedでなかった)
  • configure-auth.md (EN/JA): TokenIssuerProtocol セクションを EN 版に追加して JA 版と整合化
  • configure-auth.md (EN/JA): import パスを nene2.auth トップレベルに統一
  • architecture.md (EN/JA): schema.py の説明に「新規プロジェクトはドメイン別 ensure_schema()」の注記を追加
  • ja/how-to/run-tests.md: テスト構造のサブディレクトリを EN 版に合わせて列挙(... で省略されていた)
  • ja/how-to/sqlalchemy-repository.md: Section 5「transactional() を使った原子的マルチライト」を追加(EN 版にはあったが JA 版に欠落)

Round 3 — JA 版の欠けているページ

  • docs/ja/how-to/new-project.md: 新規作成(EN 版 new-project.md の完全日本語翻訳)

Test plan

  • uv run pytest — 167 tests passed, 91.77% coverage
  • ドキュメントのみの変更(コード変更なし)

🤖 Generated with Claude Code

Round 1 — 致命的な誤りと古いコマンド:
- configure-auth.md (EN/JA): BEARER_TOKENS/API_KEYS をJSON配列形式に修正
  (カンマ区切りはJSONDecodeErrorになる)
- ja/reference/configuration.md: .env例のCORS_ORIGINS/BEARER_TOKENSをJSON配列形式に修正
- design-philosophy.md (EN/JA): 削除済みの `uv run export-openapi` を
  `uv run python src/scripts/export_openapi.py` に修正
- 全言語のテスト数を167+に統一(EN:165+, JA/DE/FR/ZH/PT-BR:135+ がすべて古かった)
- sqlalchemy-repository.md (EN): セクション番号の飛び(4→6)を修正(→5)、末尾の孤立```を削除
- todo/current.md: v0.2.0作業中のTODOリスト(全タスク未完のまま放置)をv1.x完了後の状態に更新

Round 2 — 抜けと不整合:
- new-project.md (EN): BearerTokenMiddleware/ApiKeyAuthMiddleware/CORSMiddlewareのimport文を追加
- configure-auth.md (EN/JA): TokenIssuerProtocol セクションをEN版に追加しJA版と整合
- configure-auth.md (EN/JA): importパスを nene2.auth トップレベルに統一
- architecture.md (EN/JA): schema.pyの説明に「新規プロジェクトはドメイン別ensure_schema」の注記追加
- ja/how-to/run-tests.md: テスト構造のサブディレクトリをEN版に合わせて列挙
- ja/how-to/sqlalchemy-repository.md: Section 5「transactional()を使った原子的マルチライト」を追加
  (EN版には既に存在したがJA版に欠落していた)

Round 3 — JA版の欠けているページ作成:
- docs/ja/how-to/new-project.md: 新規作成(EN版 new-project.md の完全日本語翻訳)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@hideyukiMORI hideyukiMORI merged commit 1892ff0 into main May 19, 2026
1 check passed
@hideyukiMORI hideyukiMORI deleted the docs/doc-audit branch May 21, 2026 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant