Appearance
ドキュメント方針
SOD Docs は、プレイヤーが迷わず読めることと、運営・開発チームが仕様を更新しやすいことを優先します。
原則
- プレイヤー向けページでは、内部実装の詳細を書きすぎない。
- 開発者向けページでは、仕様、実装、運用を分けて書く。
- 未確定情報には
予定、検討中、仮のどれかを付ける。 - ルールや処罰に関わる内容は、曖昧な表現を避ける。
- 公式サイトや Discord 告知と矛盾した場合は、更新日時を確認して修正する。
ページ構成
| ディレクトリ | 用途 |
|---|---|
guide | 初めて読む人向け |
core-pvp | Core-PVP の仕様と攻略 |
server | 参加方法、コミュニティ、FAQ |
development | PMMP 開発、運用、内部仕様 |
reference | サンプルと書式確認 |
文体
- ですます調で統一する。
- 1 文を長くしすぎない。
- ページ冒頭に、そのページで分かることを書く。
- 注意事項は
warning、補足はtip、未確定はinfoを使う。
更新時の確認
- サイドバーに必要なリンクがあるか確認します。
- 内部リンク切れがないか確認します。
npm run buildが通ることを確認します。- 公式サイトと矛盾していないか確認します。
