コンテンツにスキップ

自治体向けのマニュアル作成ガイド

📘 全体の方針

  • 目的: 自治体や市民が「読みやすく」「わかりやすく」「操作しやすい」マニュアルを提供する。
  • 対象読者: 技術的知識がない自治体職員や市民ユーザー。
  • 文体の基本: 丁寧語(ですます調)を原則とする。

✍️ 文体と構成

1. 文体

  • 本文は「ですます調(敬体)」で統一する
  • 見出しは「体言止め」「常体(である調)」「〜には」など形式的なものを許容し、句点はつけない
  • 箇条書きも「本文の文体に合わせて」統一。1つのリスト内では敬体・常体を混在させない

🧭 手順の書き方

2. 書式

  • 手順書きには命令形「〜してください」もしくは「〜します」を使う
  • 「〜して下さい」は強い命令型になるため使用しない
  • 1手順 = 1文でシンプルに書く(複文や条件文を避ける)
  • 順番が重要なときは番号付きリストを使う

例:

### アカウントの作成方法

1. 「サインアップ」を選択します。
2. メールアドレスを入力し、「次へ」を選択します。
3. 届いたメールのリンクを開いて、登録を完了してください。

「してください」と「します」の使い分けについて

文型 用途例 マニュアル適性 コメント
〜してください 手順、操作指示 ◎(ベスト) 明確かつ親切なユーザー指示
〜します 解説、補足説明 状況次第で可

4. 文中の UI 要素

  • UI名は半角角かっこで囲む:[保存]、[マップを表示]
  • 項目の説明は「[○○]を選択してください」の形で表現
  • ツール名や製品名は翻訳しない
  • 「クリック」など特定の入力方法に特化した表現を使用しない
  • 理由:ユーザーは、キーボード、マウス、タッチ、音声など、さまざまな入力方法で製品を操作します。「〜選択してください」などすべての操作手段(タップ、キーボード等)に対応した表現とする。
  • UI要素の種類(ボタン、リンクなど)は使用せず、ラベル名を使用する。
  • 例:[ファイルを開く]を選択してください。
  • 非推奨例:ファイルを開くボタンをクリックしてください。
  • 理由:UIの種類(ボタン、リンクなど)は画面設計によって変更される可能性があるため、具体的なUI種別に依存しない記述とする。

5. 語調とトーン

  • ユーザーと「会話するような」やわらかい文体(ただし丁寧で明瞭に)
  • 否定表現を避ける(「〜できません」よりも「〜するには○○が必要です」などポジティブに)
  • 冗長な敬語は避ける(例:×お使いいただきますようお願い申し上げます → ○ご利用ください)

参考文献