操作ガイド
Markdown の使い方
FAQ・返信・Webページで使える Markdown の書き方を説明します
QAries では、FAQ、対応者返信、内部メモ、Webページ本文などで Markdown を利用できます。見出しやリスト、リンク、表を使うことで、長い説明や手順を読みやすく整理できます
Markdown 利用の流れ
1
基本の書式を使う
見出しとリストで文章の構造を作ります
- # や ## を使うと見出しになります
- - を使うと箇条書きになります
- 手順は番号付きリストにすると順番が伝わりやすくなります
2
リンクとコードを使う
リンクやコードブロックを使って補足情報を整理します
- [表示テキスト](URL) の形式でリンクを挿入できます
- コマンドや設定値はコード表記にすると読み間違いを防げます
- 長いコードやログはコードブロックに分けて記載します
3
表を使う
表を使って比較や設定値を整理します
- プラン差分や設定項目の一覧は表にすると読みやすくなります
- 列数が多すぎる場合は、複数の表や箇条書きに分けます
- スマートフォンで読む場合も想定して、横に長くしすぎないようにします
4
プレビューで確認する
入力とプレビューを切り替えて、保存前に表示結果を確認します
- FAQ と Webページは公開前にプレビューで見た目を確認します
- 対応者返信は顧客に送信されるため、リンクや表記ミスを確認します
- ユーザーからの返信本文はプレーンテキストとして扱われ、Markdown として解釈されません
事前に確認すること
- Markdown を入力できる編集画面を開いてください
- 公開前にプレビューで表示結果を確認してください
- 顧客に表示される文章か、社内向けの内部メモかを意識して書き分けます
書き方のポイント
- 顧客向け文章では装飾を増やしすぎず、見出しと箇条書きを中心にすると読みやすくなります
- 内部メモでは調査ログや確認事項を Markdown で整理できます
- FAQ と Webページでは同じ説明を重複させず、リンクでつなぐと保守しやすくなります