【新人エンジニア向け】マークダウンを使って分かりやすく伝える

入門

2023.07.082023.07.07

こんにちは。web系エンジニアのカズです。

現場に入ってプロジェクトに携わると、タスク管理ツールのGithubやBacklogなどをよく使うと思います。

そんな時に、マークダウン入力方式で文字入力をした方が見やすいですよね。

主にタスクのチケットに進捗状況を入力したり、プルリクエストを作成して補足情報を入力するときにマークダウンを使用するとよいでしょう。

本記事の内容

・マークダウン入力方式を使用した進捗報告の例

・マークダウンの入力方法

・マークダウン入力方式のツール紹介

マークダウン入力方式を使用した進捗報告の例

今回はBacklogを使用して例を書いてみます。

例えば、こんなタスクがありました。

タスク管理ツールを使われている前提ですが、おそらく進捗報告をすることがあると思います。

自分のタスクのチケットに進捗状況を分かりやすく記載しましょう。

またタスクのチケットに対応方法や工数見積もりの記載が特にない状態と仮定します。

進捗報告例として下記のような感じでしょうか。

まずは全体の工数を見積もって、その中の現在どの作業をやっているかを報告すると伝わりやすそうです。

そしてマークダウン方式で記入すると良いでしょう。

記号を何を入れれば良いかを覚えるだけなので、すごく簡単です。

そしてマークダウン方式で入力できるツールはたくさんあるので一度覚えておくと便利です。

主な記載方法は下記です。

種類	表記方法	表記例
見出し	行頭に#を記載 #の個数が少ないほど大きい見出しになります。	#見出し1 ##見出し2 ###見出し3
強調	テキストの前後に * もしくは _	強調
箇条書き	行頭に * もしくは –	* 項目1 * 項目2 * 項目3
番号付リスト	行頭に数字.	1. 項目1 2. 項目2 3. 項目3
引用	行頭に >	>引用文
ソースコード	テキストの前後に `	`php artisan migrate`
区切り線	3つ以上の * か _ もしくは –	– – –
表	\| で整形 \| : で左/中/右揃え – – – – – – – – -: \|	\| No \| 氏名 \| 部署 \| – – -: \| :- – – – – \| : \| 1 \| 山田太郎 \| ○○部署 \|
画像	行頭に !	![画像１](https://○○〇)
リンク	[タイトル](リンク先URL)	[タイトル](https://○○〇)