合同会社BUSTERWORKS

合同会社BUSTERWORKS

ブログBLOG

技術解説記事を書くうえで注意すべきポイント

2019.3.1
webメディア

本記事では、技術解説記事を書くうえで注意すべきポイントについて解説します。

表記を統一する

例えば、「Proxy」をカタカナで表記した場合「プロキシ」と書く場合と「プロクシ」と書く場合があります。このように表記が複数ある場合はいずれかに統一して記載します。
また、GUIなどのスクリーンショットを交えた解説の場合は、GUI上の表記と本文中の表記が同じになるようにします。
また、ボタンを「押す」「クリックする」などの言葉も揃える必要があります。

 

 読者の立場を考えて書く

技術解説記事を書く立場の人は、書く内容について精通した人になるわけですが、実際に読む人はそのことに関して詳しくない人であることに注意する必要があります。
・前提条件を明示する
・説明を省略しない
・手順を省略しない
・対象とする読者はその記述で理解できるか(ある程度理解している人にはよくわかる書き方でも、そうでない人にはよくイメージできない場合があります)
などの配慮が必要になります。

 

流れを意識する

話題を展開していくにあたって前後の関係に注意する必要があります。A→B→Cの順に展開していく記事とした場合、Aの内容はBにつながるようにします。ここでBの内容がAからすると唐突に思えるような内容であると、読者が混乱してしまいます。Webサイトであれば、読者の離脱要因となります。かならずA→B→Cの論理展開に整合性を持たせるように注意しましょう。

TOPへ戻る