OSSには設計書なんてないらしい
会社でエクセルを使ってせっせと設計書をメンテしてて気づいた。
そういえばOSSって設計書あるのか?
この実装がどんな風にされいるのかを説明してるドキュメントってあるのだろうか?
大きなパッケージだったら何人、何百人もの人がたずさわるけど
そんな中でみんなが理解できるような、記載ってはあるのだろうか?
OSSってドキュメントをどうやって管理しているのだろう?
そして、それをいまの現場に役立つように取り入れたい。
と思って、OSSにおけるドキュメンについて調べてみた。
開発者向けドキュメント
ってカテゴリ(用語)になるみたい。
出典:https://producingoss.com/ja/getting-started.html#developer-documentation
ここに開発者向けのドキュメントに関する記載あるか?
実際のGithubのプロジェクトでの開発者向けドキュメントを眺めてみる
ためしになじみがあるpandasのドキュメントを見てみたけど
https://pandas.pydata.org/pandas-docs/stable/index.html#
これ自体もドキュメントってこと??
知りたいのはもっと内部的なことだったりするけどそんなもんは存在しないのか?
さらに調べてみると
オープンソースには仕様(もしくは設計書)がないらしい
https://rheb.hatenablog.com/entry/2018/11/09/open-source-product-specs
作りたい人がコードを作るところから始まり
コードを通してコミュニケーションがなりたっているからだそうだ。
なりたちを考えてみたら納得
顧客が作りたいもののオーダーが来て、
それに合っているのか?設計に抜け漏れがないのかを
チェックしならが開発するわけではなく。
まず出来上がったものありき
そこから、どんどん積み上げていくからそうなんだな。
最初の開発を複数人でやるときは、
どうやってコミュニケーションとっているのだろう?
仕様や設計を残さないと忘れない?って思うけど。
では、googleがオープンソース化しているものってどうなの?
企業がやっているのオープンソースなので何かしらあるのでは?
ってChromium OSのページを見てみたけど
http://www.chromium.org/chromium-os
開発者向けってのがあるけど、量が多いのと自分にはなじみがなさ過ぎて
どんな仕様で作っているのかどんな設計なのか
って情報が載っているのかどうかすらわかんなかった。
でもドキュメントとかで検索すると
なんかツールがいっぱいヒットするがこのツールを使って
githubに上がっているソースを解析したらドキュメントが出来るのか?
って思ったが、そんなに手軽にできて有用なか
既にその方法が流行っているか・・・・。