🐡

“公式ドキュメントわかりづらい問題”を解決するためのWebアプリケーションを作りました

2023/09/02に公開

公式ドキュメントってわかりづらいよね

プログラミングをやっているあなたなら、プログラミング言語やライブラリやフレームワークなどの公式ドキュメントを読んだことはありますよね。

でも「なんでこんなにわかりづらく書いてるんだ...」と感じたことは数知れないと思います。

特に初心者にとっては何かの呪文にしか見えません(よね?)。

公式ドキュメントの重要性

でも、公式ドキュメントを読むことは下記の点から重要です。

  • 1次情報のため、一番正しい
  • (ちゃんと更新されていれば)最新の情報である
  • 体系的にまとめられている

などなど

ソフトウェアやアプリケーションを開発する上で、正しくて最新の情報にあたるためには、やはり公式ドキュメントの他には無いでしょう。

わかりやすく解説してくれているブログなどの記事のほうが読みやすかったりしますが、そういう記事は情報が古くなったり、ベストプラクティスではなかったり、そもそも正しくなかったりする可能性があります。

やはり一番うれしいのは、公式ドキュメントがわかりやすくて読みやすいことですよね。

こんなWebアプリケーションを作りました

なので、そんな公式ドキュメントわかりやすくしてほしいな〜を実現するためのWebアプリケーションを作りました。

その名も「GESEL」。

GESELがどんなWebアプリケーションかというと、

  1. ユーザーがわかりづらい公式ドキュメントを見つけたら、解説をリクエストする
  2. 解説をリクエストされた公式ドキュメントに対して、他のユーザーがわかりやすい解説記事を作成する

というシンプルなものです。

つまり、わかりづらい公式ドキュメントを理解できる(解せる)ようにするためのWebアプリケーションということです。

リクエストされた公式ドキュメントでなくても、わかりづらい公式ドキュメントを見つけたら、リクエストせずに自分で解説記事を書いてもOKです。

アプリケーションのリンクはこちら↓です。
GESEL

準公式ドキュメントを充実させよう

このWebアプリケーションの解説記事は、もはや公式ドキュメントではありませんが、公式ドキュメントをベースにしているということで、「準公式ドキュメント」とでも呼ぶことにします。

準公式ドキュメントが増えれば、公式ドキュメントがいろいろな角度から解説されて、いろいろな人の問題解決に役立つと思っています。

プログラミングに挫折する初心者を少しでも救うことができれば、日本のIT人材も増えて、IT後進国と言われてしまう日本を前進させる一助になったりならなかったりするのではないでしょうか?

なので、この記事を読んでいるあなたにお願いです。

わかりづらいと感じた公式ドキュメントがあったら、GESELに解説をリクエストしてください。
そして、あなたが解説できそうな公式ドキュメントがあったら、解説記事を書いてみてください。
もちろん、リクエストだけたくさんしてもらえるだけでも結構です。

きっと誰かの役に立つはずです。

そして、もっとこういうふうにしてほしいなどの意見や要望があったら、どんどん教えてほしいです。
ブラッシュアップして、良いアプリケーションにしていきたいと思っています。

準公式ドキュメントを充実させて、どんどんわかりやすい世界にしていきましょう!
GESEL

Discussion