コンテンツにスキップ

リンク方針

状態: 編集方針

関連: アーキテクチャ / 責任範囲

  • 各フォルダの入口は原則 index.md、Wiki入口は index.md
  • 1ページ1テーマ。初出や参照が役立つ箇所を、最も具体的な説明ページへつなぐ。
  • 同じ短い段落に同一リンクを何度も置かない。
  • 開発者用からプレイヤー用への参照は許可し、逆方向は張らない。
  • パスは相対指定。未作成ページへのリンクは作らず、未決事項は文章で残す。
  • 改名・移動時は参照元も更新する。
  • Wiki内には実行スクリプトや専用ビューアを必要とする要素を置かない。
  • ファイル名は英小文字のケバブケースとする。
  • index.md はフォルダの入口だけに使う。
  • 仕様の正本は対象を具体的に表す名にする。例: grid-rules.mdstream-model.md
  • 一覧を主目的とするページには -catalog.md、具体例を主目的とするページには -examples.md を使う。
  • notes.mdcomponents.mdrecipes.md のように内容の範囲が判別できない名前は使わない。
  • プレイヤー用と開発者用で扱う概念が同じ場合は、対応関係が分かる語を使う。