0.はじめに
MarkDownやGitの社内利用をもっと増やしたいなと思ってはいるが、社内利用では特定のメンバーのみ利用していたりするため、MarkDownやGitが少しでも身近にするためには、どうしたらよいかと考えてまとめた記事になります。
ちなみに、私自身は決してマークダウンが得意という分けではありません。
ここでいうGitとはGitHub以外のGit系のバージョン管理製品を含みます
以降に、メリット、デメリットと考察をまとめてみました。
あくまで、個人的な見解です(;^_^A）
1. 
メリット
- テキストエディタで編集可能
専用ソフトがなくても、編集できる。ツールを利用するとしたらMarkDownを利用した補助ツールがあると便利なぐらい。エディタはいろいろあるが、無料で揃えることが可能。 - 中身はテキストなので、ファイル自体が軽い
ファイルが軽いと何が良いかというと、読み込みに時間がかからないのと、受け渡しもしやすい。 - PDFやHTMLへの変換も可能
他のツールを利用する必要はあるが、PDFやHTMLの変換は容易。
Visua lStudio Codeのプラグインを利用したり、MkDocsなど、目次付きでHTM変換してくれるものもあります - Gitとの相性が良い
以下のように５W1Hが満たせるので利にかなってます
| 5W1H | Gitの機能 |
|---|---|
| Who（だれが) | コミット時のユーザ名 |
| When（いつ） | コミットの時刻 |
| Where（どこで） | リポジトリ ※これは若干こじつけ |
| What（なにを） | コミットに紐づくファイル |
| Why（なぜ） | コミットコメント |
| How（どのように） | Gitの差分表示機能を使って変更箇所を確認 |
WordやExcelのような変更履のファイルもしくはシートを作成して管理している場合は、手間が省けます。履歴を作ることを目的にしてしまいがちですが、どちらかというと、上記のことがわかること重要です。私は５年以上前にコミットされた情報から探し出すこともしばしばありますが、詳細な履歴が残っていることに助けられたことは何度かあります。ソースコードの管理でgit利用は今や当たり前ですが、ドキュメントも同様になって欲しいと思います
- AI活用で何かいいことあるかも
OpenAIなどの自然言語処理においては、大量にMarkdownのデータを学習している可能性が高く、実際にプロンプトエンジニアリングでも、MarkDownの形式で情報を与えた方が良い回答を得られる場合があります。
その為、あらかじめMarkDown形式でドキュメントを残しておいた方が、後々メリットがあるのでは？と思っています。
具体的、何か事例とかがあるということではないため、こちらについてはあくまで考察です。
2. 
デメリット
-
MarkDownの記述を覚える必要がある
ただし、最初は主要な書き方を覚えるだけで十分実用的に使える -
インデントの調整がなれないと違和感がある
MarkDown固有のレイアウトはある程度、割り切りが必要。
テキストで書いたものと、実際のページで見た目が違うとストレスに感じる人も。
→プレビュー表示しながら編集するぐらいしか改善策はみあたらない。。。
慣れるしかない。 -
Excel、Wordに比べ、表現の自由度は下がる
-
利用するインフラを整える必要がある
利用用途、目的によって、どこで管理するかの選択肢が多く、クラウド上で管理したくない場合は、自社内にサーバを作る必要がある。 -
gitの使い方になれる必要がある
Markdownとgitはセットで利用しないと、有用にならないため、このあたりに抵抗がある人（特に事務系の方）はある。ただし、git操作は、ブラウザ上で操作すれば、UI的にわかりやすく編集も直接できるので、あまり弊害にはならい。 -
利用するドキュメントフォーマットがあらかじめ決められている
取引先や利用者向けのドキュメントの場合は、困難かもしれませんが
3.考察
3-1．普及の障壁
社内利用を普及するうえで見えてきた障壁は、以下に尽きるのではないかなと思われます
- インフラ検討が面倒（※オンプレ利用の場合に限る）
- 何を対象にMarkDownでの管理対象とするか決められる人がいない
- Word、Excelで管理していたものを、今さらMarkDonwに置き換えるのは面倒
3-2．どんな風に進めれば
作成済みのドキュメントであったり、すでに様式やルールが決まっているものには導入は難しいため、入れやすいところから適用範囲を広げて、利用できる人を増やしていくのが一番、ベストな進め方と思われます。
- 新規プロジェクトで、最初にルールを決め
- ノウハウ共有
Qiitaとかが良い実例です
Appendix
- Gitのあれこれ
Gitを利用する場合、選択肢がいくつかあります。
以下に関しては様々な記事がでており、情報集めには苦労しないのでここでの説明は割愛します。
１）GitHub
クラウド上での会社として問題なければ、ここが王道の選択肢
他のクラウドサービスとの連携など、拡張性が高いため、こちらを推奨
２）GitLab
GitHubと同様に以前からgitのサービスを提供
コミュニティ版は、一部、機能制限はあるが、無償で自社に作ることが可能。
３）GitBacket
利用したことないので、説明は割愛。上記のサービスと基本的な機能は、ほぼ同じ
- その他、MarkDownのユースケース
１）Gitのpagesやチケット
２）Jupyter Notebook で Markdown セル
３）Qiitaの記事
４）Backlog
５）Mattermost
etc