LoginSignup
1
0

More than 1 year has passed since last update.

SEでも「テクニカルライティング」を学んでみよう!

Last updated at Posted at 2022-12-29

はじめに


以前から「読み手に分かりやすい文章を書けるようになりたい!」と思っていました。
とある企業様の歓迎スキルに「テクニカルライティング3級」と記載があり、そこで初めてテクニカルライティングという技術がある事を知りました。
面白そうだったので、さっそく勉強しながらまとめてみたいと思います!

※「日本語スタイルガイド」の本を参考に記載していきます。

参考文献「日本語スタイルガイド」

そもそもテクニカルライティング技術ってなに?


「日本語スタイルガイド」によると、次のように記載されています。

技術的な内容を正確かつ効率的に伝えるための文章作成技術

注目すべきは「技術的な内容」というところです。

なぜテクニカルライティング技術が必要なの?


私の会社では、在宅勤務がメインとなっています。それによりチャットやグループウェア上でコミュニケーションをとることも多くなりました。コロナ禍により、最近はそういった会社が多いのではないでしょうか。
文章でも自分の意見や意思を正確にわかりやすく説明できる能力は、どんな職業でも大切だと思います。

また、先ほど「技術的な内容」と記載した通り、SEとして動作概要書を書いたり、テスト項目書を書く場合にも使える技術なので、IT分野で働いてる方にもおすすめです!

「日本語スタイルガイド」によると、次のように記載されています。

書き手側が当然と感じていることが、読み手にとっては想定外というケースは日常的に発生する。 ~中略~ 読み手が自ら価値を見出せる説明にすることが、文章の品質に直結する。

相手に価値を見出せる説明が毎回できたら、なんだかかっこいいですよね!笑
 

具体的な例

ここからは、本の内容を簡単に抜粋して記載していきます。
詳細の内容は省きますが、気になった箇所だけ自分なりに書き換えてまとめてみます!

算用数字と漢数字の使い分け


私もよく文章を書くときに迷う内容です。
算用数字を使ったら、その文章では算用数字だけを使うようにしていました。実際は使い分けをした方がいいようです。

  • 数えることができる数字や任意の数に置き換えても適用するのは算用数字にします。
今日は2022年12月
300円のハーゲンダッツ


 

  • 概数や貨幣は漢数字にします。
三メートル級の波
一万円札

かっこの使い分け

  • ()は直前の内容の説明や補足説明
。
  • 「」は引用、語句の協調など
。
  • 『』は「」のなかでカッコを使いたいときに使う。

  • [ ]はメニューやボタン名を書くときに使う。
     

一文一義でかく


文を書いていると、ついつい色んな内容を一文で書いてしまいます。一つの文には一つの事柄を書いたほうが相手に伝わりやすいです。

// ダメな例
名前の入力をすると登録されますが、画面上には表示されません。
// 良い例
名前の入力をすると登録されます。ただし、画面上には表示されません。

 

一文は50文字以内がよい


これはそのままの意味です。長いと読むのに疲れるので、50文字以内にしましょう!

句読点の使い方

  • 三点リーダーで終わる文にも句点をつける。
文章がうまく書けるようになりたいな……。
  • 「」の閉じかっこの前には句点をつけない。
// ダメな例
「文章がうまく書けるようになりたいです。」
// 良い例
「文章がうまく書けるようになりたいです」

並列する語句の区切りには読点を打つ。

// ダメな例
自転車、車または電車での移動
// 良い例
自転車、車、または電車での移動

私はダメな例でいつも書いてるきがします・・。気をつけねば。

二重否定はさける

こちらもよく私がダメな例として使っていました。

  • 否定の表現は一文に一つにする。
// ダメな例 二重否定になってる
郵便番号を設定しないと、次の画面に遷移しません。

// 良い例 否定をなくす方法
郵便番号を設定すると、次の画面に遷移します。

「未満」や「~を超えて」は使わずに、「以上」と「以下」を使う

未満はそれが含まれない値ですが、誤解されやすい書き方です。
そのため、以上や以下で書き換えるほうが良いとのことです。

// 誤解を招く例
30歳未満のバスケット選手
// 誤解を招かない例
29歳以下のバスケット選手

読み手のことを考えて書こう

  • 読み手がどんな知識をもっているのか。
  • 読んでくれる人のターゲットはどんな人か。
  • 伝えたことで、どのような気持ちになるのか。

文章を書くときは、上記のように相手のことを考慮することが大切です。何事も相手の気持ちになって考えることが大切なんですね!

まとめ

テクニカルライティングは誰でも役に立つ技術だと思いました。
「日本語スタイルガイド」の本を一通り読んだことで、分かりやすい文章が書けるようになった気になっています笑

このような記事を書く場合でも、読んでくださる方がいるなら「楽しんでくれたり、わくわくしてくれたり、役になってくれる」文章を書きたいものです。

再度記載しますが、この記事の内容は「日本語スタイルガイド」の本のほんの一部を参考にして書いたものです。興味がある方は一度手に取って読んでみることをおすすめします!

1
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
0