テクニカルライティングをすっきり仕上げる原則

1. 過度にかしこまった文体ではなく、日常会話に近い文体で書きます。

2. 文章を声に出して読み、「実際の人が話しているように聞こえるか」を確認します。

3. ユーザーの関心事、特性、教育・経験レベル、文章を読む時間・場所、業務環境を念頭に置きます。

4. ユーザーが気になりそうな情報、ユーザーに必要な情報を選んで提供します。

5. すべてのユーザーが製品や関連技術を専門家と同じくらいよく知っているわけではないことを考慮します。

6. 文章を公開した後も、用語、使い方、機能の変更点を適時反映します。

7. 不要な修飾語や冗長な表現を使いません。

8. 二重受け身表現を使いません。
   例）「つかまえられる」（→ 「つかまる」）、「書かれるようになる」（→ 「書かれる」）、「読まれるようになる」（→ 「読まれる」）、「見せられるようになる」（→ 「見える」）、「忘れられるようになる」（→ 「忘れられる」）、「引き裂かれるようになる」（→ 「引き裂かれる」）

9. 「複数の／多くの／さまざまな／すべての」の後に来る語に、さらに複数を示す表現を重ねません。

10. 専門用語をどうしても使う必要があるなら、文章の中でその用語を説明します。

11. 特定の業界や職種の関係者に向けて書くときは、その業界または職種に関連する用語を使います。

12. 文章を書き終えて休憩を取った後、もう一度読み返します。

13. デスクトップで文章を書いたなら、スマートフォンやタブレットPCで読みます。印刷して読んでもかまいません。

14. 文章を声に出して読み、どう聞こえるかを確認します。

15. 話しにくい、または不自然に聞こえる文は直します。

16. レビュアーに「内容が十分理解できるか」「流れは問題ないか」「追加すべき内容はないか」などを尋ねます。フィードバックが必要な点を具体的に質問してもかまいません。

17. 特定の機能を文章で扱ったなら、「その機能が文章の内容どおりに動作するか」をテストします。

18. 「機能・メニュー名や画面の内容が文章の内容と一致しているか」を確認します。

19. スペルチェックツールで誤字脱字や分かち書きの誤りを確認します。
    おすすめツール: 釜山大学スペルチェッカー、Daumスペルチェッカー

20. 国立国語院の外来語表記法の用例を確認し、外来語表記の誤りをチェックします。

[princox]

外来語表記の誤りは本当にかなり問題が多くて、、
method、angel のようなものも、メソッド、エンジェル と書くべきなのに、そうなっていないことが多いです。

問題は、「誤った表記法」のほうがより多く使われていて、しかも SEO まで強いという……。信じがたい状況があるということです。

何が正解なのでしょうか……？ しくしく

[roxie]

現実を反映できていない表記法が問題だと思います。

[ah2dius]

https://meetup.nhncloud.com/posts/355

正解ではないかもしれませんが、参考にはなりそうです〜

[princox]

正しいものはそれぞれ「メソッド」「エンジェル」(Angel) になるようですね。
このほか、オブジェクトの場合はMSでは「オブジェクト」に言い換えていたりもしますが..

本当にテクニカルライティングはとても難しいです。

[pugh123]

良い内容をありがとうございます。