Skip to content

Documentation Standard

このリポジトリのドキュメントは、現在のブランチ上の実装を正確に説明する必要があります。

Rules

  • 各ロケールに README.mddoc_standard.md、構造化されたパッケージまたはサブシステム文書を用意します。
  • 現在のブランチに存在する API、ワークフロー、設計判断だけを記述します。
  • ディレクトリ構造は実際のパッケージ境界またはサブシステム境界に合わせます。
  • 各パッケージまたはサブシステムのディレクトリには api.mdtutorial.mddesign.md を置きます。