mieki256's diary



2018/10/19(金) [n年前の日記]

#4 [web][neta] 日付と環境さえ書いてあれば技術系記事としては合格点

技術系の記事に関しては、日付と環境さえ書いてあればそれだけで合格点じゃないのかなと個人的には思っていたり。

まず、日付があれば、読み手としては、「これは古い記事だから今も通用するか分からんな」と事前に察しがつくわけで。「古いけど、まあ、ダメ元で」な感覚で記事内容を試すから、残念な結果でも「やっぱりね」で済むし。あるいは最初から見切りをつけて、もっと新しい記事が無いか探し始めることだってできる。…日付さえ書いてあれば。

そして、環境が書いてあれば、Mac or Linux 向けのインストール手順をWindows環境で途中まで試してしまってなんだか様子がおかしいことに気づいてガッカリ、なんて事態も避けられる。「おかしいな…動かんぞ…。さてはこれってもしかして Mac or Linux 向けの記事じゃねえの? ああ、もう、これだからMacユーザは! どうしてアイツラ『Macで試した』の一言すら書けねえんだよ! 『世界にはMacしか存在しない』と思い込んでんじゃねえよ!」と無駄にイライラしなくて済むわけで。

また、「ゴミ記事を書くな」的主張のやり玉にあがってる、初心者向けのアプリインストール手順記事の類だって、日付と環境さえ書いてあれば、「この時期に、この環境・このバージョンでは、どうやらそれなりに動いていたらしい」という、動作実績のログとしての価値が付加される。動いていたことがあるのかないのか、動いていたとしたらどんな環境でどのバージョンが動いていたのか、そういった情報が残ってることで助かる場面は山ほどある、なんてことはPC使って作業してる人なら何度も体験しているはずで。

ところが、日付も環境も書いてなければ…。

「今年の話なのか、あるいは10年前の話なのか、
一体いつの時代の話なのかは分からんが、
とにかくいつかどこかの時代に、
私達がよく知るシステムなのか、あるいは珍しいシステムなのか、
一体どの環境なのか分からんが、
とにかく謎の環境の上で…このソフトウェアが動いていた…そんな事例もあるらしい」

これでは、まるで長老の口伝の昔話。もしくは神話の類。どれだけ詳細な内容を記しても、日付と環境が書いてないだけで、かなりゴミ記事に近づいてしまうわけで…。

ということで、「ゴミ記事を書くな」的主張より、
「せめて日付と環境ぐらいは書こうぜ」
「記事にはならなくてもログにはなるからさ」
と主張したほうが、まだ建設的じゃないのかなあ、と…。

とは言え、自分も時々うっかり環境を書き忘れてる時がありそうなのでアレなのだけど…。まあ、できる範囲で気づいた時には一応書いておく、ぐらいの軽い話ということで…。

以上です。

過去ログ表示

Prev - 2018/10 - Next
1 2 3 4 5 6
7 8 9 10 11 12 13
14 15 16 17 18 19 20
21 22 23 24 25 26 27
28 29 30 31

カテゴリで表示

検索機能は Namazu for hns で提供されています。(詳細指定/ヘルプ


注意: 現在使用の日記自動生成システムは Version 2.19.6 です。
公開されている日記自動生成システムは Version 2.19.5 です。

Powered by hns-2.19.6, HyperNikkiSystem Project