ITエンジニアの日常は、「書く」場面であふれている
ITエンジニアの日常は、なんらかのドキュメントを書く場面がとても多いものです。たとえばソフトウェアエンジニアの場合、以下のようなツールを使い、業務時間の多くを
- Slack・
Teams:今日の予定を投稿。チームメンバーへの相談・ 報告。今日の作業内容を投稿 - GitHub:プルリクエストにコードレビューを依頼。Issueを更新
- Notion:会議の議事録を記入
- 生成AI:壁打ちしながらコードを作成
その他、README、設計書、プルリクエストの説明、API仕様書などのドキュメントを書く機会も多いでしょうし、技術記事を書いてQiitaやZenn、はてなブログに投稿する方もいるでしょう。
テキストに構造を与えるMarkdown
IT業界では、テキストによるコミュニケーションが重視されます。テキストは記録として残り、離れた場所にいるチームにも非同期で伝わります。コードやコマンドのような技術的な内容を正確に共有できるのも、テキストならではの利点です。リモートワークの普及や海外拠点との協業が増えるなか、テキストで正確に伝える力が問われる場面は増える一方です。
テキストの量が増えるほど、構造のない文章は読み手の負担になります。書く量が多く、正確さが求められるからこそ、効率よくテキストに構造を与えるMarkdownが活きてきます。
Markdownは2004年に公開され、GitHubが標準的なドキュメント形式として採用したことで、ITエンジニアの間で事実上の標準となりました。上記で挙げたツールもMarkdownに対応しており、新しいツールやサービスが登場するたびに、Markdownへの対応が当然のこととして期待されています。
しかし、
これからMarkdownを身につけたい方に向けて、いくつかのポイントを示します。
ポイント1:「見た目の装飾」ではなく「テキストの構造」を意識する
Markdownを書く際、最も大切にしてほしいのは
Markdownでは、
構造を意識して書くようになると、誰が書いても文章の構成がブレなくなります。さらに、この
AIに曖昧なベタ打ちの文章を渡すのではなく、見出し
ポイント2:「方言」の存在を知り、ポータビリティの高い書き方を選ぶ
Markdownには公式の厳密な単一の標準規格が存在せず、プラットフォームごとに独自の拡張や解釈の違い、つまり
『ITエンジニアのためのMarkdown実践入門』
たとえば、SlackやTeamsの太字はGFMとは異なり、**で囲むのではなく*で囲みます。また、Slackでは#による見出し記法には対応していません。
方言の存在は戸惑いの原因になりますが、
あるツールでの独自の記法は非常に便利である一面もありますが、一歩ツールの外に出ると、ただの文字列として崩れてしまいます。ツール内で完結する個人メモは独自記法を自由に使い、将来的に外部に持ち出す可能性のある技術記事の下書きや仕様書は標準的なMarkdownで書く、という
ポイント3:便利な拡張機能を使って品質を保つ
Markdownはどのテキストエディタでも書けますが、VS Codeのようなプレビューや入力補助のあるエディタを使うと執筆効率が向上します。さらに、拡張機能のmarkdownlintというリンター
さらに、設定ファイルを作成して、50以上あるルールの有効・
他にも便利な拡張機能があるので、ぜひ活用してください。
ポイント4:リファレンスを活用
本書は、Markdownの書き方で困ったときに辞書
- 記法の概要:その記法が何のために使われるか
- 基本構文:記法の書き方と構文要素の説明
- 記述例と表示結果:入力
(Markdown) と表示結果の対比 - 推奨する書き方:読みやすく互換性の高い書き方の指針と、記法の制限事項
- 方言対応表:プラットフォーム別の対応状況
- よくある間違いと対処法:典型的なミスパターンと修正方法
本書
結びにかえて
Markdownは、覚えるべき基本記法が7種類程度と、非常に手軽で直感的です。しかし、そのシンプルな記法を正しく使いこなすことは、人間とAIが複雑に協調し合うこれからの時代において、エンジニアの
皆さんの日々の業務やドキュメント作成が、Markdownという共通言語を通じてよりスマートで効率的なものになることを、心から応援しています。