Helpfeelのライティングのコツ

Helpfeelのライティングのコツ

作業の進め方のコツ

ライティングに取り掛かるとき、まずは既存マニュアルやFAQの全体を俯瞰して、どういう内容があり、元マニュアルの作成者はどういう文体や方針で書いているかを大まかに把握します。そのうえで、繰り返し使われている単語があれば用語集(Glossary)にあらかじめ入れておくようにします。
いきなり1ページずつやっていくと、表記揺れなどに気づきにくいので、先に全体を眺めるの大事です。
社内のFAQは、その会社独自の用語などもあるので、全体を見て用語の意味を把握するのも大事です。

作業ログを取ります。
自分のScrapbox「#helpfeel非公開」タグを用いた非公開ページで、作業しながら気づいた点、後から確認が必要な点などはメモをしっかり残しながら進めます。
例えば、作業していると、同じ内容が複数のページで書いてあるのに気づいても、どのページのを残すべきかは全体の作業が終わらないと判断は難しいことがあります。そういうときはメモを残しておいて、一通り作業終わってからチェックする項目として扱うようにします。

重複や類似ページのリストアップしながら作業します。
作業用の仮のハッシュタグなど付けながら進めます。
時間開けるとどんなページあったか忘れるので、出来るだけ集中した時間で作業します。

タイトル関するコツ

タイトルは短くします
複数の意味を込めない
『利用代金は税込か税抜か、また、オプション料金は含めてよいか』→『利用代金』
上の例であればオプション料金はページを分けたり、本文や質問文に含めればよいです。

タイトルは記事内容の大枠がイメージできる表現とします
『税金の種類』→『利益に対する課税区分』
利益(ユーザーの状況)、課税(ユーザーに発生すること)の表現があり具体的です
税金の種類だけでは意味が広くわかりづらいです

検収が必要なコンテンツで、タイトルを変更する場合はコメント記法で元タイトルを本文に残しておきます
例: [# 元タイトル:~]
元々どのコンテンツのどのタイトルの話か作業しやすいためです。FAQの移行前後で有用です。

質問文に関するコツ


時期を示す言葉は頻出質問です。「いつの」は時期・日時・期間といった単語で拡充します。
? [申請]はいつまでにすればよいですか
? [申請]の締め切りの(時期|日時)を知りたい
? [申請]できる期間を知りたい

本文に関するコツ


Helpfeelの機能のコツ

本文中の単語にはリンクを積極的に添えましょう。
Wikipediaを作るように単語ごとにリンクを張り巡らせてください。

用語集(Glossary)は固有名詞以外にも積極的に使います。
regist:`(登録|申請|申し込み|入会)` 等にも使って良いです。
「スマホ」といった略語は、劣後を使うと効果的です。
どこでGlossaryが使われているかはScrapbox上で {regist} で検索すればわかるので、より便利です。
既存のGlossaryを編集したときは、使われてる質問文が破綻しないか確認します。

ハッシュタグを用いるのではなく、本文のリンクで関連するページが繋がり合う構成を目指しましょう。

参考文献