bcdice / BCDice

The most popular TRPG dice command engine in Japan
https://bcdice.org
BSD 3-Clause "New" or "Revised" License
138 stars 183 forks source link

エンドユーザーマニュアル #274

Closed ysakasin closed 3 years ago

ysakasin commented 4 years ago

BCDiceがどどんとふから離れたことで、choiseなどの基本コマンドのヘルプメッセージがエンドユーザーに対して届かなくなっているため、エンドユーザーマニュアルを作る必要性が高い。

作るのは確定として、どの媒体を用いるかという問題がある。 思いつく限りの候補は以下。

作ったドキュメントを読む人

エンドユーザー:ココフォリアやユドナリウムなど、オンセツール上でBCDiceのコマンドを使う人々

ドキュメントをメンテナンスする人

BCDiceコミッタ:必須 有志:オプション

考えたいこと

どのサービスを使うのがいいか。各サービスの利点と欠点

ysakasin commented 4 years ago

bcdice.org にサブドメイン切って、 honkit 使うとか

ysakasin commented 4 years ago

良さげなサービスやツールがあったら、皆さんも追記お願いします

R-F-D commented 4 years ago

以下それぞれに該当する方の参加を どの程度想定されていますか

  1. システム対応コードの寄稿者
  2. BCDice利用ツールには習熟しているが、いわゆる技術界隈に明るくないエンドユーザ
ysakasin commented 4 years ago

@R-F-D

システム対応コードの寄稿者

今回の登場人物には含まれません。 各ゲームシステムのヘルプメッセージはこのマニュアルには含めず、従来通りPlainテキストのヘルプメッセージをコード内に書き、各オンセツールがそれを表示します。

BCDice利用ツールには習熟しているが、いわゆる技術界隈に明るくないエンドユーザ

「有志:オプション」に含まれます。彼らの参加は必須要件ではありません。 採用された手法がWiki系で、いろんな人が参加できる体勢なら協力してもらう、くらいの感覚です。

ysakasin commented 3 years ago

Honkitで書くことにしました。リポジトリは以下です。 https://github.com/bcdice/docs.bcdice.org

gitbook: 多人数編集は有料のため、プレビューを見れる人が限られてしまう。有志が参加しづらいので採用しなかった bcdice.orgの子ページ: ページのデザインをするコストが高いので見送り