チャット向けフォーマット変換

メモのままの報告文を、Slack や Chatwork で読みやすい見出しと箇条書きに整えます。ログやコードはコードブロックに。

送り先

報告文（メモのままで可）

0行 / 0文字

Slack に貼る形

0行 / 0文字

使い方とメモ

見出しの判定は「短い行（16文字以内）で、句読点や記号がないもの」です。段落の1行目か、空行で区切られた1行、「原因: 本文」「対応:」のようにコロン付きの行が見出しになります。
見出しに「コード」「ログ」「SQL」「クエリ」「コマンド」「実行結果」「レスポンス」などが含まれる節は、本文を箇条書きにせずコードブロックにします。字下げもそのまま残ります。
Chatwork は Markdown を表示しないので、箇条書きは「・」、コードは [code] タグにしています。Slack は *太字* と「•」、Markdown は - と入れ子で出します。
すでに「-」「・」「①」で始まっている行は、そのまま箇条書きとして扱います。

チャットごとに書き方が違う

同じ「見出しと箇条書き」でも、チャットツールによって書き方が違います。Markdown のつもりで書いた **太字** や # 見出し が、そのまま記号として表示されてしまうのはこのためです。

やりたいこと	Slack	Chatwork	Markdown
太字	`太字`	なし	`太字`
見出し	なし	`[title]`（枠の中）	`# 見出し`
枠で囲む	なし	`[info]…[/info]`	なし
区切り線	なし	`[hr]`	`---`
リンク	`<URL\|文字>`	URL をそのまま	`[文字](URL)`

Slack の書式（mrkdwn）は Markdown に似ていますが別物で、** の太字や # の見出し、[文字](URL) のリンクは使えません。Chatwork は [info] のような角括弧のタグで書きます。このツールは見出しを、Slack では太字、Chatwork では「■」か [info][title] の枠、Markdown では入れ子の箇条書きに置き換えます。

変換の例

見出しのない報告文を貼ると、次のように組み直します。

入力
  ログイン画面の不具合を調査しました。

  原因
  セッションの有効期限が短すぎた

  対応
  設定を30分から2時間に変更
  本番には明日反映します

Slack
  ログイン画面の不具合を調査しました。

  *原因*
  • セッションの有効期限が短すぎた

  *対応*
  • 設定を30分から2時間に変更
  • 本番には明日反映します

Chatwork を選ぶと見出しが「■ 原因」、本文が「・」の箇条書きになります。最初の1行のような見出しのない前置きは、箇条書きにせずそのまま残します。

うまく分かれないときのコツ

節と節の間に空行を入れる: このツールは空行で区切った塊を1つの節として読みます。「対応」のような見出しを本文のすぐ下に続けて書くと、見出しではなく本文の1行として扱われます。
見出しは短く、句読点を付けない: 16 文字以内で「。」や「、」を含まない行を見出しとみなします。「原因について説明します。」のような文は見出しになりません。
1行で済ませたいときはコロン: 「原因: セッションの有効期限が短すぎた」のように書くと、コロンの前が見出し、後ろが本文になります。
ログやコマンドは見出しで知らせる: 見出しに「ログ」「SQL」「コマンド」「実行結果」などを入れると、その節は箇条書きにせずコードとして扱い、字下げも残します。

画面の「読み取った構造」に、どこを見出しと判断したかが出ます。意図と違うときは、空行やコロンを足して入力のほうを整えてください。

読まれる報告にするために

チャットの報告は、スクロールの途中で読まれます。最初の1行で「何の話で、結論はどうなったか」が分かるようにし、詳しい経緯は見出しの下に置くと、読む人が必要なところだけ拾えます。「原因」「対応」「今後」のように見出しの言葉を毎回そろえておくと、過去の報告をさかのぼるときにも探しやすくなります。