【Notionテンプレート】コーディングガイドライン
英語版が好評いただいているコーディングガイドライン用のテンプレートを日本語化しました！
コーディングガイドラインとはプロジェクトや制作会社ごとに定められたコーディングの規約（ルール）のことです。
具体的には「インデントをタブではなくスペース2つ分にする」「class名はキャメルケースで」などです。
複数人で作業する場合、人それぞれ書き方の好みや癖があるため、出来上がったコードの書式が統一されていないということが多々発生します。
書式が統一されているとコード全体の見通しが良くなり、コードメンテナンスの際の作業の効率化や品質維持の向上などにつながります。
Notionでガイドラインを作成するメリット
ガイドラインをNotionで作成することのメリットとしては以下のような点があげられると思います。
チームのメンバーやメンテナーなどへ共有しやすい
wikiなどすでにチーム内でNotionを使用している場合、導入のハードルが低い
コーディングガイドラインのコーディングの時間を省くことができる
テンプレートの構成
テンプレートの構成としてはシンプルで、表紙と各カテゴリごとのページが用意されていて、各ページの左サイドにガイドライン全体のナビゲーションとページ内の目次が設置されています。
表紙となるページにはガイドラインの基本方針、改訂履歴などのスペースがあります。
表紙および各カテゴリごとのページの構成は共通で以下のようになっています。
ガイドライン全体の目次: 各ページへのリンクです。同期ブロックになっています。いずれかのページでここにリンクを追加すると全ページに反映されます。
ページ内の目次: Table of contents（目次）で作成されています。ページ内に見出しを追加するとここに反映されます。
ガイドラインの本文: コーディングの際のルールとして良い例（Good）、悪い例（Bad）を記入することができます。
👉 自動生成ボタン
テンプレートに含まれているデフォルトのページには本文エリアの一番下に自動生成ボタンがあります。クリックするとボタンの上に「タイトル、テキストブロック、Good/Bad用のコードブロック」が自動生成されます。
こちらのテンプレートはGumroadにて無料で配布中です！
ページ内は英語ですが、「日本語版」を選択してカートに追加いただくと日本語版のダウンロードが可能です。
（任意の金額を入力しての購入も可能です 🙏）
最後に
👇 Notion用のすぐに使えるテンプレートをgumroad.comにて配布中です！
日本語版はこちら ↗︎ | ダウンロード方法はこちら ↗︎
👇 Notion公式ギャラリーページ
少額でもご支援いただけると制作活動の励みになります🙏 いただいたサポートは誰かの役に立つコンテンツを制作する活動費に使わせていただきます！