技術記事を書く・読むときの心構え

初めに

最近ちょっと技術記事を書く人への批判とその批判をする人たちをたたく、というような場面を目にして、以前から思うところがあったのでこの度自分の考えを記事にしました。

そういう状態を画像にするとこんなイメージです。

この記事で少しでも優しい業界になれたらなと思っています。

結論

簡潔にまとめるなら「書く側は正確に、読む側は寛大に」です。

記事を書く側の心構え

受け取り方は人それぞれなので、100%伝わる、理解できる文章はありません。
ですがそれに近付けることはできます。具体的に

• 適切なタイトル
• わかりやすい文章と流れ
• 正確な情報と言葉
• 動画、GIF、図を用いた説明

上記を意識すればよいかなと思っています。
ほかに注意すべき点があれば、ぜひコメントください。

読む側の心構え

相手が一所懸命記事を書いたということを忘れないようにしましょう。
また読んだ記事に、何かしらのコメントをするなら次のことを意識するとよいでしょう。

• 相手が受け入れやすい言葉選び
  • 「〜しないとだめ」より「〜するとよいと思います」
• 強い言葉は使わない
  • 「なんで攻め」より「〜の意図、理由はなんでしょうか？」
  • 「〜できないって実際試しました？試していないでしょ？」より「〜を実際試していないなら試してみましょう」

記事を書くのはとてもたいへんです。1つの記事を書くのに次のことをしなければいけません。

• 情報が正しいか
• 自分の理解が合っているか
• 言葉と説明が正しいか
• ターゲット層に伝わるか

ぱっと思い付くだけでも上記があります。内容と量によっては数日かかることもあるでしょう。
それを一所懸命書いて公開した内容をきつい言い方されたら、傷つくでしょう。だって、人間だもの。

記事を書く側は不正確な情報を意図して書いているわけではないはずです。
相手を蔑むような言葉を選ぶなら、それは相手に伝えたいのではなく相手を威嚇したいだけでしょう。
感情に任せて威嚇は動物がすることです。論理的に考えれば威嚇は相手が傷つくし言いたいことは伝わらないし自分の立場が悪くなるし、メリットが何ひとつありません。

とどのつまり、相手に伝わるかを考えればよいと思っています。

最後に

• せっかく記事を書くなら、誰もが理解しやすい、正確な内容を
• せっかくコメントするなら、相手に伝わるような言い方を

これだけと思っています。

書く側は正確に、読む側は寛大に