💾

Google ドキュメントでマークダウン記法使えるから社内ドキュメントもうこれでいいなってなった。

2022/12/11に公開約1,500字

こんにちは、やぐちはるおでございます。起業してから約1年、社内ドキュメント整備を悩みに悩んで Google ドキュメントにした話を書きます。

はじめに結論

「① ページ分けなし」で 「② マークダウン記法を検出する」設定にする

~完~

社内ドキュメントを作成するにあたり欲しかった機能

  1. 【重要】ページ分けがない
  2. 【重要】標準的なマークダウンが使える
  3. 【重要】サービスが消えることになっても被害が少ない
  4. 【最重要】非 IT エンジニアでも簡単

1 番目は、ワードとか使ってレポート書いているとありがちですが、ページの境目に近いところで画像挿入した瞬間にレイアウトが最悪になるため NG です。

2 番目は、マークダウンで書けると簡単に素早く良さげなレイアウトのドキュメントが作成できるからです。TeX 系 は「簡単」の部分から少し離れてしまうので NG です。

3 番目は、notion や独自フォーマットの〇〇 wiki 系 は辞めるときに別サービスへの移行が大変なので NG です。

4 番目は、社内ドキュメントなので、IT エンジニアや PC 得意な人だけが使いやすいツールだと、それ以外の人がドキュメントの作成や閲覧から遠ざかってしまう可能性があるため NG です。1-3 を満たす Type.md というサービスがあるのですが、非 IT エンジニアが触りづらそうな状況だっため、使用を断念することとなりました。

Google ドキュメントは結論の通り 1, 2 の設定が出来ますし、無いと思いますが最悪サービスが潰れても一括ダウンロードで.docx が zip されます。また、フォルダとワードみたいなものなのでだいたい非 IT エンジニアでも触りやすいでしょう(希望的観測?)。

以降、1, 2 の設定について記載します。

ページ分けなし設定

このアドベントカレンダーの 2 日目に解説記事があるので御覧ください。

Google ドキュメントの「ページ分け なし」とは?

マークダウンを検出する

Google ドキュメントは今年の3月頃から順次さまざまな国でマークダウン記法が使えるようになっており、日本でも夏頃にいつのまにか使えるようになっていました。

設定手順は以下のとおりです。

1. [ツール]→[設定]

2. [Markdown を自動検出する]

以上です。

おわり

あとはマークダウンで入力すれば自動で見出しやリストに変換されます。

一度見出し 1(#)で書いた部分も再度見出し 2(##)で記入し直すと、ちゃんと見出し 2 に変換してくれるので便利です。

普段の開発風景についてはTwitter アカウントでつぶやいているので、良ければフォローください。フォロバします。

GitHubで編集を提案

Discussion

ログインするとコメントできます