Markdownガイドラインの導線復活

future-architect · Dec 26, 2024 · 82446b1 · 82446b1
1 parent 9f2fcb7
commit 82446b1
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/documents/forMarkdown/markdown_design_document.md b/documents/forMarkdown/markdown_design_document.md
@@ -37,8 +37,6 @@ Markdown に限った話では無いが、どういった内容を設計書に
 ::: warning 有志で作成したドキュメントである
 
 - フューチャーアーキテクトには多様なプロジェクトが存在し、それぞれの状況に合わせて工夫された運営方針が存在する。本規約はフューチャーアーキテクトの全ての部署／プロジェクトで利用されているわけではなく、有志が観点を持ち寄って新たに整理したものである。相容れない部分があればその領域を書き換えて利用することを想定している
-- 自社のセキュリティポリシーや外部サービス利用ポリシーがある場合は、そちらを優先すること
-- Slack Enterprise Grid／Google Workspaceを利用しているため、それらの機能を前提にしている記述がある
 
 :::
 

diff --git a/index.md b/index.md
@@ -22,8 +22,11 @@ hero:
       text: Gitブランチフロー規約
       link: ./documents/forGitBranch/
     - theme: alt
-      text: Slack利用規約
+      text: Slack利用ガイドライン
       link: ./documents/forSlack/
+    - theme: alt
+      text: Markdown設計ドキュメント規約
+      link: ./documents/forMarkdown/
 features:
   - title: Readability
     details: ソースコードの可読性を高く保つことで、保守性・拡張性の高いソフトウェアを作ることができます。 しかし、可読性の指標は複数あり、デベロッパーごとに判断がブレ、それぞれのスタイルで記述すると、ソフトウェア全体で見たときの可読性が下がってしまいます。 本コーディング規約は、コーディング時の判断のブレを防ぎます。