ドキュメントについて思うこと

とんとんぼ
·

ドキュメントってあると嬉しい

だって、公式が「こうしたらうまくいくよ〜」って教えてくれるから、

でもたまに、更新が途絶えていたりして情報が古くなったりするんよね。

これだと、せっかく興味を持ったのに時間がかかったり、うまくいかなくてやる気がなくなったりしてしまう。

では、「メンテナーが常にドキュメントを最新にするよう注意しろ」という話かというとそれもちょっと違う。

メンテナーは常に忙しい、機能の実装から編集、編集リクエストのレビュー、Issueの回答、とやることは山ほどある。

自分が思う最適解

ではどうすべきかというと、ドキュメントは誰でも編集できるようにすべきというのが私の最適解であると思う。

ここで大切なのは「編集権限」は誰でも持ち、編集内容を「承認」するのは権限を持った人間が行うべきであるという考えである。

要は、OSSのPRのようなもの、

これによって、メンテナーは他のことに力を注ぐことができ、ドキュメントは常に最新にすることができると考える。

必ずしもこの方法でドキュメントが最新になるかというとそうとは限らないが、何ヶ月も何年も放置されるよりマシ

@ktombow1110
続くかどうかわからないサイト