はじめに
会社の Advent Calendar 向けに、何か記事を書くことになりました。当初は GitHub を使いやすくする Google Chrome 拡張を作る話でも書こうと思ったのですが、時間が確保できなかったので Slack のヘルプ記事を意訳して少しだけお茶を濁します。Slack と英語の勉強にもなるからいいかなと。
記事について
Slack Help Center にある公式のヘルプ記事 Formatting your messages の日本語訳になります。背景としては、エンジニアだけでなくマネージャーやデザイナーさんたちも Slack を使うようになったので、Slack の使い方を覚えてチーム内のコミュニケーションがより円滑になるといいなぁと思ったからです。非エンジニアの人に「英語のページ読めば分かるでしょ」は優しくないですよね。
皆さんのチームにも私みたいに英語が poor な人がいて、そんな人にこのページを紹介してくれたら非常に嬉しいです。もし好評だったら他のページも訳すかもしれないので、是非コメントいただければと思います。次に訳すとしたら Emoji and emoticons とか Emoji reactions あたりですかね。Creating a Snippet でもいいかも。
メッセージの書式を設定する
Slack のメッセージに書式設定を追加するのは簡単です!以下で紹介するように、私たちは書式設定のための便利なオプションをいくつか用意しています。
※ 訳注:Slack ではテキストの前後に半角スペースがないと書式設定が有効になりません。例えば ここは*強調*される
は、テキストの前後に半角スペースを入れて ここは *強調* される
と書く必要があります。日本語のように分かち書きしない言語のことも考慮してほしい…。
強調(太字・斜体)
Slack のメッセージ内の単語やフレーズを強調するために、*アスタリスク* でテキストを囲むと太字テキストが、_アンダースコア_ でテキストを囲むと斜体テキストが作成されます。
※ 訳注:アスタリスクは星印やスター、アンダースコアは下線やアンダーバー、アンダーラインとも呼ばれます。アンダースコアは、標準的な日本語キーボードなら Shift + \ で入力できます。
打ち消し線(取り消し線)
メッセージの訂正箇所を示したり、TODO リストの項目が完了したことを表すなら、打ち消し線を使ってみてください。線を引いて削除したいテキストを ~チルダ~ を使って囲みます。
※ 訳注:チルダは「にょろ」と呼ばれることもあります。波線(〜)や全角チルダ(~)とは異なります。標準的な日本語キーボードなら Shift + ^ で入力できます。
リスト(箇条書き)
リストを作成するには、Shift + Enter を押してメッセージに新しい行を作成し、各項目の前に番号または黒丸(•)を追加します。
※ 訳注:強調や打ち消し線のようにリスト形式に変換されて表示される訳ではありません。あくまでも「新しい行の先頭に番号や記号を付けるとリストに見える」というだけで、入力したテキストはそのまま出力されます。
引用
インデント(字下げ)や引用のために、メッセージの先頭に山括弧(>)を追加します。
> 単一の行をインデントします
>>> 複数行からなる段落をインデントします
※ 訳注:三重の山括弧(>>>)を使うと、それ以降に続く行も(山括弧がなくても)引用とみなされます。
コードブロック
固定幅のコードとしてテキストの一部を表示するには、バッククォートでテキストを囲みます。
`単一のバッククォート` は固定幅のテキストをインライン(行内)表示します
```三重のバッククォート``` は固定幅のテキストをフォーマット済みのブロックとして作成します
コードブロック内での構文の強調表示は現在サポートされていないため、太字や斜体などの追加の書式は表示されません。より強力にコード共有をするなら、私たちはスニペットを作成する(英語)ことを提案します!
※ 訳注:バッククォートはグレイヴ・アクセントや backtick とも呼ばれます。引用符(')とは異なります。標準的な日本語キーボードなら Shift + @ で入力できます。
※ 訳注:スニペットは Slack 内でコードを共有するための簡易ノートのような機能です。メッセージ入力欄の左端にある [+] ボタンを押して "Create a Snippet" を選択するか、ショートカットキーの Shift + Ctrl + V(Shift + ⌘ + V)から作ることができます。
FAQ(よくある質問)
Markdown 構文を採用しないのですか?
一部のユーザーが Markdown オプションを望んでいることを私たちは知っていますが、今のところ Slack のメッセージで Markdown をサポートする予定はありません。現在の書式設定オプションは、他の一般的なサービスでも使われているので、Markdown 規約をよく知らない多くのユーザーにとって使いやすいでしょう。
※ 訳注:つまり Markdown だけでなく軽量マークアップ言語(reSt や Wiki 記法、はてな記法、BB コードなど)や簡易 HTML に対応するつもりはないってことですね…残念。
bot メッセージに書式設定を追加できますか?
bot メッセージの書式設定については、API ドキュメントのメッセージの書式設定(英語)を参照してください。
※ 訳注:Slack に組み込まれているロボット(自動プログラム)のことを Slackbot と呼びます。Slackbot はユーザーが自由に作ることができ、Slack のメッセージ中の特定のキーワードに反応して結果を返したり、GitHub や Jenkins などの外部サービスと連携して Slack に通知を流したりできます。Slackbot が返す bot メッセージでは、リンク付きテキストなど使用可能な書式設定が少しだけ拡張されています。
おわりに
Qiita 初記事なのでおかしなところがあるかもしれませんし、残念ながら訳者の英語力には期待できません。誤字脱字や誤訳などありましたらコメントなどで遠慮なくご指摘ください。よろしくお願いします。
Slack のヘルプを読んでも書式設定の書き方がイマイチ分からない…という方は "DIRECT MESSAGES" にいる slackbot で練習してみてください。入力したメッセージは他人からは見えないので間違えても恥ずかしくないはず。
それから Slack 日本語版が欲しいという方は Using Slack in different languages というページに次のような記述があります。
In the future, we’ll translate Slack into more languages.
(あまり期待しないで)待ちましょう^ ^