ドキュメントは共有しやすく簡単に書きたい
ドキュメントは書いた方がよい、となってもどのように書いていくのがいいのかというのもある。
「ドキュメント」のイメージを書いた方がよかったのかもと思いつつ、、、
イメージは仕様、要件、スケジュール、設計とか制作に関する物がイメージとしては多いかも。
Word とかで書いて共有するというのは更新の観点、最新版がどれで、どこにあるか？がわからなくなるという観点からあまりないだろうと思うが。
ファイル共有するツールを選べばいけるところはあるかもしれない。
プロジェクト管理ツールの Wiki 等でいいのか、 Google Docsでよいのか。
リポジトリに Markdown ファイルをいれることで共有できれば良いのか、様々なところが判断基準になる気はする。
誰か1人だけが書くものではないので、誰でも書けるようになっている必要はある。
Markdown の書き方がわからない場合もあるかもしれないが、そこはテキストベースでの構造化という観点で覚えておいてもらうラインになりそうな気はする。が、これもあくまで主観。
Markdown だと Table が扱いづらいという話はある。
リポジトリに入れたとしても、ブラウザでアクセス権さえあればローカル環境がなくても編集・作成はできると思う。
とはいえとっつきにくさの問題は避けられない所もありそう。
Markdownベース、リッチエディタベースでの wiki 的なものを共有しやすいサービスは色々あるので、そこで共有、更新ができるのでもいいと思う。
同時編集とかができればなおよし。
テキストだけだと表現力の限界があるので、そこは別のツールと補完し合いながらということになるかと思う。
デザイン的な要素をいれたいなら Figma の情報を入れるでもいいだろうし。
とりあえずキャプチャをとって貼りつつ、リンクを入れるだけでも理解はしやすくなるはず。
設計に関するところでは画像（キャプチャ）にコメントなどする必要もあったりするので、それらが編集、改訂しやすい作りになっていると便利だったりはする。
miro とかでつくっておいて miro 自体も共有するがキャプチャをドキュメントに貼り付けるのでもよいとは思う。
コメントをいれるなど編集した画像をキャプチャとっておきつつ、その編集した画像は再編集できるようにしておく必要がある。
Google Docs だと画像の編集はそんな感じが出来た気がする。
Excalidraw あたりを組み合わせてもいいのかもしれない。
Excalidraw+ | Online whiteboard collaboration made easy
https://plus.excalidraw.com/
シーケンス図とかUMLくらいはコードで書きたいという場合もあるかもなので、それを埋め込めるようにしておきたい、、、という気はする。
が、まぁこれもドロー系のサービスとか別サービスとの連携でどうにかなるかもしれないが。
Markdown などのドキュメントを共有できるようなサービスやプロジェクト管理ツールの Wiki 系のサービスだと拡張された機能があるので便利に利用できる。
埋め込み系だったり、ドキュメント同士のリンク機能や、プロジェクト管理ツールのタスクなどを取り込んだり。
便利ではあるのだけど、そのサービスに依存してしまうので、移行が必要になった時には何かしら作業が発生するというのを忘れないようにする必要がある。
Markdown の延長というか拡張で機能が豊富なものはあるんだけど、そのための環境構築が必要になるというのは若干本末転倒なきもするので、そこの線引きは難しいところだと思う。
Re:VIEW とか AsciiDoc とか個人的には気になるけど書くために覚えることがあるというのが悩ましいところ。
そういう懸念があるからなかなか自分でも触ってみようというのになりづらい。
ドキュメント系のサービスなどでこれらを使えるところが少ない印象もある。
Markdown は諦めて Google Docs で作ることも多いのだけど、差分が見づらいとかあるのかもしれない。
SpreadSheet みたいなツールも差分は見れるが使う側にとって本当にわかりやすいのかという点も意識しておきたいところ。
Textlint 等の校正ツールは Markdown & リポジトリ管理みたいなフローであればいれておいて自動化しておくことで、、、という可能性はありそう。
それぞれの資料がファイルベースになって分かれていたりするとそもそも検索がしづらいという話もあるので、そこも考えておく必要はありそう。
Word で管理して、ファイル共有だと全体を検索するのは一手間かかる可能性もあるかも。
とはいえ、似たような話はMarkdownのファイルを共有した場合もあるかもしれない。
Google Drive で共有することにして、検索は Google Drive の機能に寄せるということも可能かも。
サービスの場合は費用がどういう感じなのか。メンバー単位なのか、プロジェクトやチーム単位とかなのかでも採用可否も変わりそう。
結局のところ使えるツールによって判断が変わる可能性も往々にしてある。
自分は良くても他の人に使いづらい、だと書くためのハードルは上がってしまう。
エンジニア視点で使いやすいツール。
非エンジニア視点で使いやすいツール。
ドンピシャな物はないきがするがいい落とし所は探す必要があると思う。