Skip to content

ドキュメントと規約

  • APIコントラクト: APIに対して明確なOpenAPI/Swagger仕様を維持します。AIはこれらを使用してクライアントを生成し、リクエスト/レスポンスを検証します。
  • 一貫した命名: 変数、関数、クラス、ファイル、モジュールには予測可能な名前を使用します。
  • コードフォーマット: 厳格なフォーマッター(Prettier、Blackなど)を強制し、AIが生成したコードがプロジェクトのスタイルに一致するようにします。
  • JSDoc/Docstrings: 複雑なロジックやビジネスルールを説明するコメントを追加します。AIはしばしばこれらを活用して理解を深めることができます。
  • README: 機能ディレクトリ内のREADMEファイルにモジュール/機能の責任を文書化します。

VitePressで構築