技術系記事に入れておきたい要素

仕事柄インターネットで検索する事が多く、技術系の記事を目にする機会が多々ある。
そこで読んでいて気になった点、記事を投稿する場合に入れておきたい要素を三つ紹介する。

一つ目は投稿日だ。
書いた時点の情報を記載していると思うが、投稿日が分からないと閲覧時点では古い情報になっていることがある。
一度掲載しており、修正を加えている場合は記事の修正だけでなく、最終更新日時も記入していると参考にしやすくなる。

二つ目は実行環境だ。
使用しているOSやソフトウェアが異なると、記載されている操作の実行ができないことがある。
特にWindowsとMacOSでは画面から異なっているので、明記しておいた方が見る人に優しい。

三つ目はコマンド文だ。
画像だけでなく、文章で置いておけばコピー&ペーストで使い回せるし、コマンドの解説があれば各々で設定できる。

上記をまとめると、技術系の記事について、
・投稿日または最終更新時刻
・実行環境
・コマンド文
の三つを入れると読者が参考にしやすくなるだろう。 試して見て欲しい。

Related posts