documentation
新人プログラマ応援
QAccelerator

documentation > 動作環境を書こう > テンプレート使用

症例

Windows 10 Fall Creators Updateでの設定情報を探していたら、Windows 10 Anniversary Updateの情報で時間を潰した経験がある人。

まだ経験がないWindows 10ユーザは、そのうち、そういう経験をするので大丈夫?です。

動作環境を書こう

動作環境
Windows 10 Pro (64bit) バージョン 1803 (April 2018 Update)
Google Chrome バージョン: 66.0.3359.170(Official Build) (64 ビット)

Qiita記事に上記のような動作環境があれば、数秒目を通して「探している情報かどうか」判断できます。
閲覧者にやさしいドキュメントになります。

その閲覧者は「将来の自分」かもしれません。

面倒な操作の回避

記事ごとに動作環境を書くのは面倒、と思われる方。
確かに面倒です。
テンプレートもないですし。

2018年5月現在僕がしているのは、以下のツール(Q Accelerator)を使ってテンプレートにしています。
Qiitaをより便利にするChrome拡張機能をつくりました by @howdy39 さん

以下のようにしています。
Q Accelerator > 新規投稿時のテンプレート > 動作環境のテンプレートとしての使用案

rawgitでは更新がうまく行かないので、githackで使っています。
https://github.com/howdy39/q-accelerator/issues/180

単純な作業

「退屈なことはPythonにやらせよう」というようなタイトルの本があります。

退屈な(or 単純で時間がかかる)作業は適切なツールを使って効率的にするといいでしょう。
情報の精度を高めながら、他の作業に時間をまわすことができます。
(2018年5月現在、Qiita記事数ナンバー1の人が思っていることらしいです)。

未来へのメッセージ

@ プログラマが知るべき97のこと by Kevlin Henney

未来へのメッセージ by Linda Rising

「自分の書くコードは、全部、未来の誰かへのメッセージだと思うのよ。その誰かは、あなたの弟さんかもしれない。誰か、とても賢い人に、自分が難しい問題をどう解いたのか、丁寧に説明するつもりで書くの」

未来の我々が平穏に過ごせますように。