Skip to content

ドキュメント方針

SOD Docs は、プレイヤーが迷わず読めることと、運営・開発チームが仕様を更新しやすいことを優先します。

原則

  • プレイヤー向けページでは、内部実装の詳細を書きすぎない。
  • 開発者向けページでは、仕様、実装、運用を分けて書く。
  • 未確定情報には 予定検討中 のどれかを付ける。
  • ルールや処罰に関わる内容は、曖昧な表現を避ける。
  • 公式サイトや Discord 告知と矛盾した場合は、更新日時を確認して修正する。

ページ構成

ディレクトリ用途
guide初めて読む人向け
core-pvpCore-PVP の仕様と攻略
server参加方法、コミュニティ、FAQ
developmentPMMP 開発、運用、内部仕様
referenceサンプルと書式確認

文体

  • ですます調で統一する。
  • 1 文を長くしすぎない。
  • ページ冒頭に、そのページで分かることを書く。
  • 注意事項は warning、補足は tip、未確定は info を使う。

更新時の確認

  1. サイドバーに必要なリンクがあるか確認します。
  2. 内部リンク切れがないか確認します。
  3. npm run build が通ることを確認します。
  4. 公式サイトと矛盾していないか確認します。

play.sodmc.jp:19132