TASHIKA Docs

Appearance

ドキュメントルール ​

docs/ 配下のドキュメント作成・編集時に適用するルール。

言語 ​

対象言語
ドキュメント本文日本語
コード例・コミットメッセージ英語
ファイル名英語 (kebab-case)

ID 採番 ​

→ 詳細は 採番ルール を参照

  • フォーマット: {PREFIX}-{3桁} (例: BF-101, DM-201)
  • 新ID は該当ブロックの次番号を使用
  • ID は不変、欠番許容、再利用禁止
  • 単一定義場所（1つの ID は1箇所でのみ定義）

相互参照 ​

  • 形式: → [ID 説明](相対パス)
  • リンクテキストにはファイル名やディレクトリパスではなく、人間が読める説明を使う
    • ○ [家族構成](../domain/family/)
    • ✗ [docs/domain/family/](../domain/family/)
  • 特定セクションへのリンクにはフラグメント（#見出し名）を付与する
  • 要件 → 設計 → 実装のトレーサビリティを維持
  • 新セクション追加時は index.md も更新
  • docs/ 配下にページを追加・移動・削除した場合は docs/.vitepress/config.ts のサイドバー設定も必ず更新する

変更管理 ​

  • フェーズ指定: MVP, v1.1, v2.0, Future
  • 廃止 ID は ~~DEPRECATED~~ 表記（削除しない）

図表 ​

  • スタイル規約: → 図表スタイルガイド（カラーパレット）
  • ノードと関係を持つ図（フローチャート、シーケンス図、状態遷移図、ER図、アーキテクチャ図、データフロー図、コンテキストマップ）は Mermaid で記述する（Markdown 内にコードブロックとして埋め込む）
  • beautiful-mermaid により VitePress ビルド時に SVG に変換される（ライト/ダークモード両対応）
  • ER図の物理スキーマ可視化には Liam ERD を使用（DB実装後）
  • ASCII art は以下の用途に限定: ディレクトリツリー、数式・計算式、フォーマットパターン例
  • 上記以外での ASCII art による新規図の作成は禁止