yamaday0uです。
※2022年から技術系の記事は個人ブログに投稿しております。ぜひこちらもご覧ください→yamaday0u Blog
今回は技術的な話ではなく、Qiitaなどで技術記事を書くときに皆さんにお願いしたいことについて書きます。
What
技術記事を書くときに皆さんにお願いしたいこと。
それは
参考資料を掲載することと、
なるべく公式ドキュメントを載せることです。
Why
参考資料を載せてほしい理由は、記事を読んだ人に自走力をつけてもらうよう促すためです。
公式ドキュメントを載せれば、公式ドキュメントを参照する意識を醸成したり、ドキュメントの読み方まで伝授できます。
原典や一次情報から情報を知ることは正しい知識をつける上で非常に重要です。
正しい知識は問題解決のときに活かせる汎用性のある知恵になります。
ぼく自身、いろんな方の技術記事を読んで、自分の問題解決に活かしていますが、その方が参考にしたサイトを何も載せていないと、「この人は何を読んでこの解決法に至ったんだろう？」と惜しい気持ちになります。
また同じ問題で詰まったとき、その人の記事だけが頼りになってしまいますし、時間が経てば記事の情報が古くなって使えなくなってしまいます。
参考にした公式ドキュメントのリンクが掲載されていれば、公式ドキュメントの情報が更新されている可能性が高いので、問題解決がしやすくなります。
手前味噌ですが、ぼくがQiitaで記事を書くときは必ず参考にしたサイトのリンクを最後に載せています。
例えば以下の記事で下の写真のように参考資料として、記事を書くときに参考にしたサイトの一覧を記載しています。
こんな感じで参考資料を技術記事で掲載してくれる方が増えると、ぼく自身の学習も捗るので、ぜひ心がけてくれると嬉しいです。