パンジェンシーの「汗だく開発日誌」

システム開発の備忘録です。

【Markdown】テレワークでのコミュニケーションに役立つ書き方5選

パンジェンシー『東の森でシステムエンジニアをしております、パンジェンシーと申します。 ここに、エンジニア向けの内容を書くのは約4年ぶりデス。 これからまた、お役立ち情報を書いていくので、よろしくお願いします!』

チャットスキルを上げよう!

f:id:x-fieldatts:20200722135820p:plain

今年(2020年)は、新型コロナ感染拡大で、世界的に大変な状況になってます。 システムエンジニアの方は、自宅からテレワークという方も増えているのではないでしょうか。 テレワークでは、(おそらく)チャットツールでのやりとりがメインになっていることかと思います。 システムによっては、Markdownを使いこなせると、コミュニケーションが少し円滑になるかもしれません。

ということで今回は、チャットでのやりとりが捗る、Markdownの書き方について書いていきたいと思います。私が実際に、チャットツールGItLab等でよく使うものを挙げましたので、ぜひ使ってみてください。

(ちなみに、↑の文章もMarkdownを使って書いています。)

1. 箇条書きしたい

文章の前に、-(スラッシュ+半角スペース)を入れると、箇条書きになります。

課題の共有、打ち合わせのメモなど、複数の項目を箇条書きしたい時に便利です。これは一番使う機会が多い書き方だと思います。Markdownを書いたことある人なら、知らない人はいないかと思います。

システムによっては、- [ ]/- [x]と書くとチェックボックスにすることもできます。GitLabだと、- [ ]と入れておけば、チェックボックスになり、後でボックスをクリックするだけで、チェックを入れることができるので、TODO管理にも便利です。

書き方

- 箇条書き1
- 箇条書き2
+ プラスも使える
* アスタリスクも使える
  - 一段下げたい
    - もう一段下げたい

表示結果

  • 箇条書き1
  • 箇条書き2
  • プラスも使える
  • アスタリスクも使える
    • 一段下げたい
      • もう一段下げたい

-の代わりに、1.と書くと項目に番号を振ることもできますよ!対応している書き方がシステムによって違うかもしれないので、事前にプレビューなどで確認してみましょう!』

2. 一部のテキストを強調したい

強調したい単語を、**アスタリスク2個)や、__(アンダースコア2個)などで囲むと、太字になります。文章で、プログラムの説明なんかを書く時には、`(バッククオート)で囲むといい感じです。

書き方

単語を**強調したい**場合は、__このように__書く。

*あいうえおabcde12345*と書くと、イタリックになるっぽい。

文章内に、関数名`function()`や変数名`const name = 'pangency'`を書く場合、
`this`のように書くと見やすいデス。

表示結果

単語を強調したい場合は、このように書く。

あいうえおabcde12345と書くと、イタリックになるっぽい。

文章内に、関数名function()や変数名const name = 'pangency'を書く場合、 thisのように書くと見やすいデス。

*アスタリスク1個)の場合、イタリックになります。(フォント、文字種によってはならないかも?)』

3. ソースコードをがっつり貼り付けたい

3回連続のバッククオートで文章の上下を挟みます。

プログラムについて質問したり、質問に答えたりする時に便利です。また、この書き方は「pre記法」といって、改行やスペースをそのまま表示してくれる特徴があるので、勝手に改行されたくない場合、インデントに深い意味がある場合などにも使えます。

書き方

 ```javascript
 const name = 'pangency'
 window.onLoad = ( ) => {
     alert(`${name} is genius!`)
 }
 ```

表示結果

 const name = 'pangency'
 window.onLoad = ( ) => {
     alert(`${name} is genius!`)
 }

『バッククオートの後に、プログラミング言語を指定すると、色がつきますよ!(シンタックスハイライトといいます。IDEと同じですね。)』

4. リンクを貼り付けたい

参考ページやチケットへのリンクなどを共有したい時に便利です。直接文中にリンクを埋め込む方法と、参照リンクを作る方法があります。短いリンクの場合は前者でよいですが、複数のリンクを貼りたい場合や、リンクが長い場合などは、後者の方法のほうが便利です。

書き方

[ここ](https://www.google.com/)を押すとグーグルに飛びます。

[ここ][ggl]をクリックするとグーグルへ飛びます。
パンジェンシーの出ている漫画は[これ][manga]です。

[ggl]:https://www.google.com/
[manga]:https://medibang.com/book/fb1502020112110000000020088/

表示結果

ここを押すとグーグルに飛びます。

ここをクリックするとグーグルへ飛びます。 パンジェンシーの出ている漫画はこれです。

『下の参照リンクの部分は表示されません。gglmangaの部分は何でもよいです!番号とかでもよいです!』

5. 書いた文章を取り消したい

~~で取り消したい文章を挟むと、取り消し線が入ります。メッセージ自体を削除してもよいですが、「取り消した」という事実を残しておきたい場合もあります。そういう時に便利です。

書き方

~~パンジェンシーはパンダです。~~
パンジェンシーはパンダではありません。

表示結果

パンジェンシーはパンダです。 パンジェンシーはパンダではありません。

『パンダではありませんよ!』

おわりに

今回は、よく使うMarkdownの記法を紹介しました。

チャットでのやりとりの他にも、Wikiの編集GitLabなどのタスク管理単純なメモ、など、汎用的に使える言語だと思います。

ツールによっては想定通りに表示されなかったり、独自の記法があったりしますが、基本を知っていれば応用できると思うので、ぜひ使ってみてください。

『今回の報告は以上です!ではまた!』