create-specment 0.2.3 → 0.2.9

package/templates/docs/03-external/img/gantt.xml

@@ -0,0 +1 @@
+<mxfile host="localhost" modified="2021-05-18T09:41:40.835Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36" version="@DRAWIO-VERSION@" etag="MlFZ1QgpfDXi1VSEqS1e" type="device"><diagram name="Page-1" id="8378b5f6-a2b2-b727-a746-972ab9d02e00">3Z1Nc9s4EoZ/ja8uAuDnMWM7s3vI1lYlVTlOMRZjayOLWkqeJPvrV7RFW0DDBGES3U3mMJullcR+mnjxdqMBXKirh19/NuXu/lO9qjYXMlr9ulDXF1KKOMqP/9M++f38JInj5wd3zXp1+tDrg8/r/1Wnh9Hp6eN6Ve21Dx7qenNY7/SHt/V2W90enp+d/mzZNPVP/WPf643+r+7Kuwo8+Hxbbrqnl8nr86/r1eH+9FykxesX/lGt7+5P/3gus+cvfCtvf9w19eP29C9u6231/JWHsvtrTt/p/r5c1T/PHqmbC3XV1PXh+XcPv66qTQu2Y/b85z6+8dWXH6WptochfyBVz3/i73LzqOPYH353KPaHpv5RXdWbunl6oK5vbq4/Hv/KP76vN5uz5x+ur9R1Ab+H01/5d9Ucql9nj07f059V/VAdmt/Hj5y+mqcd/dPbo/ITsJ+vkYhPj+7PYvDyBpyif/fyV79COP7mxOENJjFgclU/7DbVoWp/rqb+T/u+yaj6Vd0+Htb1FgArN+u77fG3m+r78fv6A5+fkEMAKhmKYAIIqqTVgvL3nsHbFcdHOtHLL5GlTlR5dBmd/ZJ5IHApHI7pZRRfCsmAWyI1bpINtQxSu4xSHtDSSH/ZwLumIyJjmAOGg+FNACnvf7McjGw6lkxCpQBURrxTV1c3ySS4dFqRNN6porgszn+hzZxZBHDdbO/W26pq1tu7yabJyTgKORKkEvonAg3OTACuE8ynk2E05lPZCzFXVBKXyQCT62QQzclVcaVoyRjGTraTQTQn21yDGEc6IkHGEGYYCnG2NaePTKdk1zSM6QOmDf8+y7bKh/W2HJNvBZgwfNGZE0ZmI6m9g5GIJyBrySue5w/E1653mjDRZWRj05JM+M4SoWcDPrBg1kAAy6H6kiwxzWD6ECPrvI4iNiZA+OKE0vYcpgafysMxLyjbT+131e36+/qWg7z7EgtWRcuh65e+pn9y1RZZPx+qoZZbzH1GLttMWVksfE6u2v0DLyaDBb16gqvh8flUL3RKKZ2gQ7N+Juh1sxpV85lGy8eRU9I6XicHydCbizTpp0U2Gi3uvKCWeVEwhWVx5/iwHDqfctF56NVTQp3XIRkM4gRN5gtLSf+/j+vdQ/ujymhT/q4fD7yE3hcdks4X0M4rejtvCr2BS5GNxwIa+jZOvJSeDy1o6WXMTeoNFmRVqwJa+gxX6s9ryKle20siF6VgUg8d/efHXdX8vd4/VWWicrs6/vehqlrBh6JFVoX3JmhW4eNAQKGzb180YsnvSpCDaWGNSmjtZUIt+MYCDx9Y0NorcRklpHovZS8s2D6BBQta+5xQ743xZ7jPFE3vRQS9/R/rp4/U39tvoW5+cFJ5X25IKi8iaOzJCzimyDthIQ1F0dXER7SPBBd5PrDG99oEF3kDFmx5QIMFXX0xGBNar6Yy3jV9mQOWCsOJP3T7X1vBv69379V8vEZNX4rmVND12ff13agpIFsygMg3A8Br3BR9VOn8m4gsqYFvdQOvczPhShHmDNI3Z6Bq3TRHOFn7q4hgMtFtWSRp3jQ4pVTziYDJxBvNm10d6XW1+LZ+ODJZ78l7f0aAHdTZOQVnjl1BMkr6aBGKXqdttIXx/nZORrQsywj4NTjHVJBymQoEzDi60cmgjz/JXZzCzQW2Rv6qlfh2oTharY9M1t9Oe6ejb3XZrBgVmrw5okm/JZvgJ/0GLrLuFyEsWQO3Tn5GtCzZAX4DrUP6DVqwlwONliULwORktgvpkpXqKy8CcU1BwjTgU/24fW4RiqrX1iFKtR+FLli/v5DQ2jPoEOrnQzcEJXT2irxBSHKFZTH21MvFRnuQCYtuJUFafD3y/lxNofSms1QvVAvYcxZO3C1rBmtmbf6+sALKuaWx37v4H1zPnYDQRh206wpdovrlnA8r+75bXnouXU4KjZbFrCPvwz2XqMx4q2LXvBdMzxU061+qPa92fm9aZju/CgWPYyFexJ60sMaggm693Z9LK+9GeYERLfsOXWJ9F320JB0si10fvkUXrGh/fPo1vewbXeppSif7lvJ8efujvJvykLbJMJoTgjdHMCGEagRV43fyhsNoThQq9cSINpwtZfvRbSqTYTRnELYUQzT7TEbRMbOkXGYWS+IwfFNw0J5STRENi5w78AWbWGKYT3xcV5vVZJPKpA2lYxCac0qoKSW2LAkI3ywDrYEUTCoujFgDObZkH74nIaA1kJpzChuIMCnx3nOG1z8qeiHSNQ3FlmyFbvexTimLXJTCTR0wJzlNHdHuqXXoqXl0f9F1j67Wd2PSlWlmkBEgzZ6hUFhhSsJgB3KmPGmhDU6OxwuxhcWxY8jYfWHSoluBjy25BN0uZGEsbWW6n5WISUMCk4ar8tumvWtnU/5mpfHe0JBUPoFZQsxP5SUTH5vAZIC+cYgrK4vnp16HMCXeYEW3Kp9YrP3wLchTS3yU6WuBWeyaCsNJPDT3/9zuD+Vm020JY6b0/uxMpZfWHcZTsLQsMtB3icrYFxjaoISWPqZedzZ2mDCCZbH05H2ixpYJkxbZGUwigZb+5V5PioOFjHkxJdP79I1NABfs9355MzR1P1S3UQotvu/acgDR94SFNTC71ZzzgUnfS5pxpWXZG0Bv8lUvLTrRt9wO3P2wHETfWOdA7CqyXPrbbQ6Ym+o7IaKpPjT7DAo7cS8twqFpPyaIl+zzoWXx+gU32ddhdC3XFLQsXh+TU97baJFHLk7BZN9y5y+LPQSjaBn6nqeh+nssN/tKcoHvgLyBi2wMWi7wbQv3tPquYqawJujWmVzeVS8rQlgWU093I+9L32nHSTreqXDiDj09I1X3pIQn6tC18xFzFyW0IQfNOh8RZwMJenQ24m0wknSQLNYc+5rdM1kyOk9zfbnCckVQMPW23LnLR729MZnynYdaYbXcu0sn3y/3j77BiU6bLDfuEgq45EoJ2nA6BZdpLyW6Exosl+xi37Lb0+eXp3QSztmAe2NCaoe03KhLKeC9kAiViZUBF1wpcXLgpn6nbPTbYsGRb8/tE6bcxSmYfluuz+Wj356QkNTbck8uH/U2INE1bViux+Wj3nwocXbfBqWCjhJ034iUMoOSBkkZkHK4Xm47vzGZhssA8x2QS99RhLRcSP11FrPlQuqos5QtlxEeGhwYcB3fiGl45cN5ZXAKC4gLmmkGuHIPmcbEJS232CKOutxDpXGxkNro3DgYJuXDhdQ45+lwLkJYThgOCIbUK+c5XzCk9riI+IIZ4Y/DTVRF7xmvtMBGGOeAwGIPYDFshg/Ii9RQFylbLqRF6SJny2WEcx7PRUS9l1cps5yDCMZyOSsqGA9Jxs1NpeU6VVQyHtqLTWaEUQ43WYnIQ5WxiY1w0CGJsdVrywWqmINPeOj1S4sKDhjSyrMwFwoZgSEtPR+zBbZgSK2yEMOLz8hcSK2yEMOLzK/pIQ4YllVmIYeXmZGByREeOiSw4QVobGC01loOXyfEBjPCWU8BZrhWywTTP1suKUXl4qHVuFxobbLykGRcLrQuWfUe208KhmWdWSiPRUFZWJp+AxIbYZ9DEvNYLsQmRmuslcd6ITYZ2ip07LFgiEzGct8oKhkPwVaywFRsy2WiqGQ8lBmbDK1Zjj0UGJsMz3Jz7NPJgVoLslwUygFY4iPYuJmq5aZQzMHXfzEWLRnaQnTiY6WRydBWohPGgk1rmRMPYVYp6itD65jNq+P4gLFcqMlhxkp9jDQusBE+OiQwj3VDXGAA15dy/+P45F/lQwXIGXyOhipOrm1bVk8XBXdf+Xr6SWTLuN4ebJ9sn38+/VNiCubtO6pj7kaTfo8rJBtPAHaAN58TzXwITNsu6ilYWq7VOQ6R6MOuOf7XcpzhnMCm/c05+gkt3Z6OM+Yi1NZ16Pw/LRl06gJtE4opOMM84susOWf9TVVknGFW8nXenPt7tMg4wxxn5u9zv3Uj4wxTpo/z5tyft5NxtrTOf5436P4yAB1omLrNG3TeX1agAw2TvuvH5nQT44x5m4tYmQHc8NKWomhu/4Sez+gfERPEA+aKnw9lc5h1MMzSfX9ewycWMNe8+fJh1pEwq5tFbySgDBEFAuafbU1lGUl/7jU4EJN+y/aKeWf9DtJ0czBMR+edJpkHfrABDfPReef95gkibEDDhHTmbzTTgqFlH8q8M3/HCSd0oJeWkJono7ABDRPSmYPu786hA225Eyxaiql2HNfizjiDuWrLAua8XbUDdepEHewFh1njvE2I46wdQtIwU5y3r3ad3kOIemm5ous8IELUMFuct7cGBwz1WxFM1DBfnLfpAycTsUFt2XY1d9Rea5iYqGHOeFTv6FP5e/4G23VeEqHDtmwSm7fDdrEmfMNhDjlzN+I47YoQNcwbZ+6xHednEaJeWuJonsjFCDXMHGfusYXLjeCxhanizJ2edC0O4LGFueHc2brWA/DYwmSw7cRZiG+W/bMeoW+27C+cuW92sKab9iw7E2fuMCRXhxHDbHDmvtm84JQP6sVlg4pr4h3DbHDmvtlxgB6i/4hh+jdzb+c4aw+TLcz35s7WVejHYwvzvfabX4hvNs/4A74ZcA5nlGHyN3Oj7ICL+RIvrXMUHMFIxzaBCd7MrbB5iCMh28VldOYOOkK2MIWbudl1HCSJyday33DmbNkU4BOYpM2creN0Sky2li2B+WLMrt+GWdgzHu4goKXtCXShJmvPTxbX6GkeU8qG9NJ2BYJjT9mQXlxyZx6jyoV0ClO9mVtmx7msdKRh4jdzk+c40JWONEwD506a69ZAy6IpIL2/L3ftbx9+3TXl7v7y+6b+eXtfNofLXVPfVvv9BThD98NNLJS0ReP5J7RGo96Vt+tDy6SrX0169KN+kmkc6czhjQSFYb4tJ6CI4rI4+5WrKSIy5H4HIyJl09Q/95ffjrD+atpv76+nJ4Pjsq23lTUkq3VT3T4dEaWu9/Xj8fn4uGR9F4vFUkdqORVZ6GFRXYvFeWBCxGXINRKTjZQ3IxJ2kCgjGsYLDo/N1z+Q56lCGiVDrqiYXTT6T1GNDUGyXC5nfEJiRWPItRjzi0ZvGhsbk3ae8BkcQ+7imF04zCNwdA+V6PO5gPNGpnTUCVIwhlz/MbtgmFmaMXEkUo8GdFdkYwNWJhZmrwzVMqYQHWlnNuntlWXJemFx0eUryvTAZM5KP1FcYNVjWXExlcwQMuGaVqjigpq4o1kuY44vjEGigywswTCGkSUYIWYVy+L6skZJ3nd7fJzbkTIYJahJ+9Dy1vEtnSAkZn1LC4nK4Qo9UUHLsoC/AKV6OvlUnypS11RhW6sPQhw1HUct6lqw29/qM+xJOoD7FNiXmXYfZSaGk25HXz8nXMApOSeakReZdrdH8L0djNSogcAkwlxo6hLz4NF4R9bNPxqOE81SadRrQTikbmjzLikMHQ5L08ASwqH6MrnUrI2DaOjByLAKhJa+gkUEw1hZMqTKueSto06FwgrHMhNrvSoo9bGR6RMHHBoG6SxHmjfSd+TV/INhHqSrlwIzo3aeO4QqR6qcp4tcADePylT6slIWu5I6pUcjxZKpRWbV5j6v7iy0Lhqp37JS2vnO4NFY5AK4uTOsqzl30dBTO2VZANdZxxmWv11kJv7c7a2FIHdmfFg1pxQ130atOWWg5pTqb76EjTj5gJpTlk0CfukL2saNPFKfEpLMYV2JVh6ypa9nm6UovfaRFK66IFVcFr+e/VSU0uVKcA3GO3LteQXjqSSlB0Ods1YpTO+ogrH0NeznkpQejESfPdgsXGfvSLZnFYz+y4Qy4TJYVHF5R9o9q7i46iFKz/nYxOUdCfi84mJWRoy4JEzj8o5MfGZxAdlhpqckis8M/44cfV7B6N8PnxXO8iFGYI7/t6nrw9nX/mxRf6pXVfuJ/wM=</diagram></mxfile>

package/templates/docs/03-external/index.mdx

@@ -0,0 +1,46 @@
+---
+id: index
+sidebar_position: 1
+---
+import { TBD } from '@site/src/components/TBD';
+
+# 外部設計
+
+:::note Note
+1. 全般で <TBD/>
+1. これから編集していくもの
+:::
+:::tip Tip
+1. 外部設計はお客様視点で描くもの
+1. お客様が見て理解できるように記述することが重要
+1. システム化するもの、システム化しないものを明確に記述する
+:::
+
+## システム概要
+1. [ビジネスモデル図](business-model.mdx)
+1. ユースケース
+    1. aaa
+    1. bbb
+1. 業務フロー
+    1. aaa
+    1. bbb
+
+## ネットワーク
+1. 外部IF定義
+
+## アプリケーション
+1. 使用アーキテクチャ
+1. 機能
+    1. フロントエンド(画面)
+        1. ここで細かいことを決めない
+        1. 目的は必要となる画面数とその概要の把握
+    1. バックエンド
+        1. 画面の機能を実現する上で必要なバックエンドを記載する
+
+## 画面設計 - モックアップ
+1. 画面デザイン
+
+## データベース
+1. ER図
+    1. 概念データモデル
+    1. 論理データモデル

package/templates/docs/04-internal/batches/_category_.yaml

@@ -0,0 +1,2 @@
+label: 'バッチ'
+position: 4

package/templates/docs/04-internal/batches/import-products.mdx

@@ -0,0 +1,68 @@
+---
+sidebar_position: 2
+tags:
+  - batch
+  - product
+---
+import { TBD } from '@site/src/components/TBD';
+
+# import-products - 商品取込
+## 概要 {#overview}
+1. 商品情報をTSVファイルで受け取り、テーブル`product`にレコードを追加・更新(upsert)する
+
+## 前提条件 {#prerequisite}
+1. <TBD/>
+1. 読込先フォルダー
+    1. <TBD/>
+1. TSVファイル名
+    1. `abc-yyyymmdd-hhnn-x.tsv`
+1. TSVのmax行数は10000とする
+    1. それより大きい行数だった場合、警告メッセージを出力する
+
+## サイクル {#cycle}
+1. cron
+    1. `5 0 * * MON-FRI`
+    1. 土日はデータ量が少ないため、実行しない
+
+## フロー {#flow}
+
+:::info info
+1. 設計はアクティビティ図ではなく、シーケンス図がオススメ
+1. 各フェーズごとのエラー処理、メッセージ内容は明確にする
+:::
+
+```plantuml
+@startuml
+!define uml https://raw.githubusercontent.com/flatring/plantuml-stencils/main
+!include uml/colorset/ocean-blue.iuml
+!include uml/colorset/_skinparams.iuml
+
+participant User
+User -> A: DoWork
+activate A #FFBBBB
+  A -> A: Internal call
+  activate A #DarkSalmon
+    A -> B: << createRequest >>
+    activate B
+      B --> A: RequestCreated
+    deactivate B
+  deactivate A
+  A -> User: Done
+deactivate A
+@enduml
+```
+
+## 関数 {#functions}
+### funcFileExistenceCheck - TSVファイルの存在確認
+1. <TBD/>
+
+### funcFileRead - TSVファイル読込
+1. <TBD/>
+
+## TSVファイルカラム {#tsv-file-columns}
+
+|   #   | Header    | Logical name | Type    | Digit | Comment                    |
+| :---: | --------- | ------------ | ------- | ----: | -------------------------- |
+|   1   | id        | ID           | integer |     - |                            |
+|   2   | name      | 名前         | string  |   255 |                            |
+|   3   | is_member | is会員       | boolean |     - | true:会員<br/>false:非会員 |

package/templates/docs/04-internal/batches/index.mdx

@@ -0,0 +1,25 @@
+---
+sidebar_position: 1
+hide_table_of_contents: true
+---
+# バッチ一覧
+## データベースインポート {#database-import}
+| ID                                     | 機能名   | 機能概要                                   |       cron        | input                   | output             |
+| -------------------------------------- | -------- | ------------------------------------------ | :---------------: | ----------------------- | ------------------ |
+| [import-products](import-products.mdx) | 商品取込 | tsvの商品情報をテーブル`product`に取り込む | `5 0 * * MON-FRI` | `products-yyyymmdd.tsv` | テーブル `product` |
+| import-orders                          | 注文取込 | tsvの商品情報をテーブル`order`に取り込む   | `9 0 * * MON-FRI` | `orders-yyyymmdd.tsv`   | テーブル `order`   |
+
+## 履歴へ移動 {#move-to-history}
+| ID                 | 機能名         | 機能概要                                                         |     cron     | input                    | output                     |
+| ------------------ | -------------- | ---------------------------------------------------------------- | :----------: | ------------------------ | -------------------------- |
+| to-history-product | 商品履歴へ移動 | バッチ実行日時-180日に作成されたレコードを履歴テーブルに移動する | `5 0 5 * *`  | テーブル `product`       | テーブル `product_history` |
+| to-history-order   | 注文履歴へ移動 | バッチ実行日時-180日に作成されたレコードを履歴テーブルに移動する | `11 0 5 * *` | テーブル `order_history` | テーブル `order_history`   |
+
+## エラーレベル定義
+| ステータス | 説明                                                                                         |
+| ---------- | -------------------------------------------------------------------------------------------- |
+| `FATAL`    | 致命的なエラー。ただちに対応しないとビジネスに影響がでてしまう場合                           |
+| `ERROR`    | エラー。バッチを継続するには問題がある場合。明確なメッセージと対応方法を定義しておく必要あり |
+| `WARN`     | 警告。継続はできるが何らかの対処が必要な場合                                                 |
+| `INFO`     | 情報表示。バッチの状態や経過を表示する場合                                                   |
+| `DEBUG`    | デバッグ用。本番環境でこれが出力されないようにする                                           |

package/templates/docs/04-internal/index.mdx

@@ -0,0 +1,32 @@
+---
+id: index
+sidebar_position: 1
+---
+# 内部設計
+
+:::tip
+1. 何故その言語、フレームワークを選定したかを書いておく
+1. 実装が済めば(リリースされれば)詳細なことはソースに書かれているはず
+    1. なので仕様には「なぜそのコードに至ったか？」など実装ではかかれないことを明記することに注力する
+:::
+
+## 要約
+### 規約・ルール
+1. 実装時に必要な規約、ルールを管理する
+1. 
+
+### 運用ポリシー
+1. Pull Requestなど運用時に必要なことのまとめ
+1. 開発時の共有事項など
+
+### 画面
+1. 実装時の重要事項
+1. コーディング時にそこに至るまでの経緯を残しておく
+1. 関連したissue、pull requestを書いておくと後任者は助かる
+
+### テーブル定義
+1. 各テーブル定義。モデル更新時には合わせて更新する
+
+## 参考情報
+1. Qiita: [【11万文字越え】プログラミング初心者に贈る即戦力ガイド](https://qiita.com/nuco_bk/items/27f5ad03d0c4b41241fc)
+

package/templates/docs/04-internal/policies/_category_.yaml

@@ -0,0 +1,2 @@
+label: '運用ポリシー'
+position: 3

package/templates/docs/04-internal/policies/branch-naming-rules.mdx

@@ -0,0 +1,110 @@
+---
+sidebar_position: 3
+tags:
+  - git
+  - branch
+---
+# ブランチ命名規約
+
+ブランチ名の統一性を確保し、プロジェクトの管理を容易にするため、以下の規則に従ってブランチ名を命名してください。
+
+## 基本ルール {#basic-rules}
+
+使用可能なブランチ名の種類は次のとおりです。これ以外の命名は禁止します。
+
+:::tip tip
+接頭の `\p` はイメージ表示に使っているPlantUMLの決まり事なので利用時には不要なので注意
+正しくは各詳細で確認すること
+:::
+
+1. `\p{#issue_id}` = `[0-9]+` : GitHubのIssue ID
+1. `\p{summary}` = `[a-z0-9-]+` : 概要を英語で書く
+1. `\p{date(yyyymmdd)}` = `[0-9]{8}` : 作成日(作業開始日)
+1. `\p{commit_hash}` = `[a-f0-9]{7,40}` : コミットハッシュ
+
+```pumld
+@startregex
+^((feature|bugfix|hotfix)/\p{#issue_id}-\p{summary}|revert/\p{commit_hash})-\p{date(yyyymmdd)}$
+@endregex
+```
+
+### Feature
+
+1. 機能開発用
+1. 新機能の開発や改善作業で使用します。
+
+```bash
+feature/{#issue_id}-{summary}-{date(yyyymmdd)}
+```
+
+- 例: issue IDが `10` の場合
+
+```bash
+feature/#10-add-api-nameabc-20250316
+```
+
+### Bugfix
+
+1. 本番環境バグ対応用
+1. 本番環境で発生したバグを修正するために使用します。
+
+```bash
+bugfix/{#issue_id}-{summary}-{date(yyyymmdd)}
+```
+
+- 例: issue IDが `15` の場合
+
+```bash
+bugfix/#15-fix-login-error-20250316
+```
+
+### Hotfix
+
+1. 緊急の修正対応
+1. 本番環境で発生した致命的な不具合に対し、緊急対応を要する場合に使用します。
+
+```bash
+hotfix/{#issue_id}-{summary}-{date(yyyymmdd)}
+```
+
+- 例: issue IDが `20` の場合
+
+```bash
+hotfix/#20-critical-security-patch-20250316
+```
+
+### Revert
+
+1. 変更の取り消し用
+1. 過去のコミットを取り消す際に使用します。
+
+```bash
+revert/{commit_hash}-{date(yyyymmdd)}
+```
+
+- 例: コミットハッシュが `abcd123` の場合
+
+```bash
+revert/abcd123-20250316
+```
+
+## 使用可能文字 {#allowed-characters}
+
+1. アルファベット小文字 (`a`-`z`)
+1. 数字 (`0`-`9`)
+1. ハイフン (`-`)
+
+必ず **ケバブケース**(単語同士をハイフンで繋ぐ)を使用してください。
+
+## 使用禁止文字 {#prohibited-characters}
+
+1. 大文字 (`A-Z`)
+1. スペース (` `)
+1. アンダースコア (`_`)
+1. その他記号 (`!`, `@`, `#`, `$`, `%`, `^`, `&`, `*`, `(`, `)`, 等)
+
+## 注意事項 {#notes}
+
+1. ブランチ名は可能な限り明確かつ簡潔にしてください。
+1. issueがない場合は省略せず、必ずissueを作成したうえでブランチを作成してください。
+1. 一度作成したブランチの名前を変更することは禁止します。

package/templates/docs/04-internal/policies/github.mdx

@@ -0,0 +1,100 @@
+---
+sidebar_position: 1
+tags:
+  - git
+  - github
+---
+import { TBD } from '@site/src/components/TBD';
+
+# GitHubの利用方法
+
+## 基本的なGitHubの利用ルール
+
+### コミットメッセージのルール
+1. 簡潔で分かりやすいコミットメッセージを書く
+1. プレフィックスを使用する（例：`feat:`、`fix:`、`docs:`、`style:`、`refactor:`、`test:`、`chore:`）
+1. 現在形の動詞で始める（例：「Add」「Fix」「Update」など）
+1. 50文字以内に収める
+
+### ブランチ戦略
+1. `main`/`master`ブランチは常に安定した状態を保つ
+1. 機能開発は`feature/機能名`ブランチで行う
+1. バグ修正は`fix/バグ内容`ブランチで行う
+1. リリース準備は`release/バージョン番号`ブランチで行う
+
+### プルリクエスト(PR)のルール
+1. 明確なタイトルと説明を書く
+1. 変更内容を詳細に記述する
+1. レビュアーを指定する
+1. 関連するIssueがある場合は参照する
+1. CI/CDのチェックが通過していることを確認する
+
+### イシュー管理
+1. 新機能やバグは必ずイシューとして登録する
+1. イシューには適切なラベルを付ける
+1. 担当者を明確にする
+1. 期限がある場合は設定する
+
+## SSHキー作成からGit Cloneまでの手順
+
+### SSHキーの作成
+
+```bash
+# SSHキーを生成（メールアドレスは自分のものに置き換える）
+ssh-keygen -t ed25519 -C "your_email@example.com"
+
+# デフォルトの保存場所とパスフレーズを設定（Enterキーで進める）
+# パスフレーズは設定することを推奨
+```
+
+### SSHエージェントへの追加
+
+```bash
+# SSHエージェントを起動
+eval "$(ssh-agent -s)"
+
+# SSHキーをエージェントに追加
+ssh-add ~/.ssh/id_ed25519
+```
+
+### GitHubアカウントにSSH公開キーを追加
+
+```bash
+# 公開キーをクリップボードにコピー（Linuxの場合）
+cat ~/.ssh/id_ed25519.pub | xclip -selection clipboard
+```
+
+- GitHubにログイン
+- 右上のプロフィールアイコンをクリック→「Settings」を選択
+- サイドバーの「SSH and GPG keys」をクリック
+- 「New SSH key」ボタンをクリック
+- タイトルを入力（例：「Work Laptop」）
+- 「Key」フィールドに公開キーを貼り付け
+- 「Add SSH key」ボタンをクリック
+
+### SSHキーの動作確認
+
+```bash
+# GitHubとの接続をテスト
+ssh -T git@github.com
+
+# 初回接続時は確認メッセージが表示されるので「yes」と入力
+```
+
+### Gitの初期設定
+
+```bash
+# ユーザー名とメールアドレスを設定
+git config --global user.name "あなたの名前"
+git config --global user.email "your_email@example.com"
+```
+
+### リポジトリのクローン
+
+```bash
+# SSHを使用してリポジトリをクローン
+git clone git@github.com:ユーザー名/リポジトリ名.git
+
+# クローンしたディレクトリに移動
+cd リポジトリ名
+```

package/templates/docs/04-internal/policies/pull-request-operation-flow.mdx

@@ -0,0 +1,118 @@
+---
+sidebar_position: 2
+tags:
+  - git
+  - pull request
+---
+# Pull Request運用フロー
+
+## 主な運用フロー
+
+```pumld
+@startuml
+
+skinparam responseMessageBelowArrow true
+autonumber "<b> [00]"
+
+participant local as "branch: feature/ブランチ名"
+participant develop as "branch: develop"
+participant staging as "branch: staging"
+participant main as "branch: main"
+
+develop -> local ** : clone &\ncreate branch feature/ブランチ名
+local -> local: commit changes
+local -> local: create Pull Request & review
+local -> develop: merge feature/ブランチ名 into develop
+local -> local !! : delete feature branch
+
+develop -> develop: CI/CD checks
+develop -> staging: merge develop into staging
+staging -> staging: perform release validation
+staging -> staging: e2e test
+staging -> main: merge staging into main
+
+main -> main: tag version &\nperform release
+@enduml
+```
+
+### 手順
+
+1. \[01\]: developブランチをクローンし、ローカルでfeature/ブランチ名を作成する
+1. \[02\]: feature/ブランチ名でコードを修正しコミットする
+1. \[03\]: feature/ブランチ名内でPull Requestを作成し、レビューを依頼する
+1. \[04\]: レビュー完了後、feature/ブランチ名をdevelopへマージする
+1. \[05\]: feature/ブランチ名を削除する(自動)
+1. \[06\]: developブランチでCI/CDチェックを実行する
+1. \[07\]: developをstagingへマージ
+1. \[08\]: リリース前の検証をする
+1. \[09\]: stagingブランチでE2Eテストを実行する
+1. \[10\]: テスト完了後、stagingをmainへマージし、リリースを実施する
+1. \[11\]: mainブランチでタグを作成し、正式にリリースする
+
+## エンジニアの動き
+
+```pumld
+@startuml
+start
+
+:Issueからfeatureブランチを作成する;
+:コード、テストを実装する;
+#Aquamarine:(A)
+:テストをする;
+
+if (テストは成功したか?) then (はい)
+  :Pull Requestを作成する;
+  :レビュアーを指定する;
+  #LightSkyBlue:(B)
+  :レビューを受ける;
+  
+  if (レビューは承認されたか?) then (はい)
+    :レビュアーがPull Requestをマージする;
+    :Issueをクローズする;
+    stop
+  else (いいえ)
+    :フィードバックに基づいて修正する;
+    :修正をコミットする;
+    #Aquamarine:(A)
+    :再レビューを依頼する;
+    #LightSkyBlue:(B)
+    detach
+  endif
+  
+else (いいえ)
+  :テストが通るように修正する;
+  #Aquamarine:(A)
+  detach
+
+endif
+
+@enduml
+```
+
+## Pull Requestのベストプラクティス
+
+1. **小さくまとめる**: 一つのPRは一つの機能や修正に焦点を当てる
+1. **明確なタイトルと説明**: PRの目的と変更内容を明確に記述する
+1. **テストの実施**: PRを提出する前に必ずテストを実行する
+1. **レビュープロセスの尊重**: レビューコメントに対して建設的に対応する
+1. **マージ前の確認**: マージ前にコンフリクトがないことを確認する
+
+## PRレビューのチェックリスト
+
+### 機能面
+
+1. 要件を満たしているか
+1. エッジケースを考慮しているか
+1. バグやパフォーマンスの問題がないか
+
+### コード品質
+
+1. コードは読みやすく、理解しやすいか
+1. 命名規則に従っているか
+1. コードの重複がないか
+1. セキュリティ上の問題がないか
+
+### ドキュメント
+
+1. コメントやドキュメントが適切か
+1. 必要な場合はドキュメントが更新されているか

package/templates/docs/04-internal/rules/_category_.yaml

@@ -0,0 +1,2 @@
+label: '規約・ルール'
+position: 2

package/templates/docs/04-internal/rules/database.mdx

@@ -0,0 +1,139 @@
+---
+sidebar_position: 5
+tags:
+  - Database
+---
+import { TBD } from '@site/src/components/TBD';
+
+# データベース
+
+:::tip
+1. 編集中
+1. どんなプロジェクトでも使えるレベルなものにしていきたい
+:::
+
+## オブジェクトの命名規約 {#object-naming}
+### 全般 {#general}
+#### プライマリーキー、外部キー
+1. 各テーブルのプライマリーキーは `id` とし、serial型とする
+1. リレーションする際はこの `id` を使う
+1. プライマリーキーに意味を持たせない
+1. 外部キーとのリレーションはテーブル名 + `_id` とする
+    1. 例
+        1. 親: `class`
+
+            | 論理名   | 物理名 | 型      | コメント       |
+            | -------- | ------ | ------- | -------------- |
+            | id       | **id** | serial  | auto increment |
+            | クラス名 | name   | varchar | -              |
+
+        1. 子: `student`
+
+            | 論理名   | 物理名       | 型      | コメント       |
+            | -------- | ------------ | ------- | -------------- |
+            | id       | id           | serial  | auto increment |
+            | class_id | **class_id** | integer | 外部キー       |
+            | 姓名     | name         | varchar | -              |
+
+#### 日付 / 日時 {#date}
+1. 命名
+    1. 年月日のみの場合は"xx日"、時刻まで必要な場合は"xx日時"とし、明確に使い分ける
+        1. 日にちを表す項目は `受動態_on` となり、date型
+        1. 日時を表す項目は `受動態_at` となり、timestamp型
+1. timestamp型はすべて `timestamp(6) without time zone` とする
+    1. タイムゾーンを持たせない(標準の `UST`)
+1. 例
+    1. 親: `classes`
+
+        | 論理名   | 物理名     | 型        |
+        | -------- | ---------- | --------- |
+        | 締切日   | closed_on  | date      |
+        | 締切日時 | closed_at  | timestamp |
+        | 削除日   | deleted_on | date      |
+        | 削除日時 | deleted_at | timestamp |
+
+### 大文字を使用しない
+1. 物理名は小文字とアンダーバー("_")のみを使用する
+1. テーブル名、カラム名ともに大文字を使用しない
+    1. データベースによっては大文字と小文字を違う文字とみなす場合、みなさない場合があるので小文字で統一する
+
+| OK/NG | 名前         |
+| ----- | ------------ |
+| :o:   | **document** |
+| :x:   | DOCUMENT     |
+| :x:   | Document     |
+
+#### 単語の連結はスネークケース
+1. テーブル名、カラム名ともにスネークケースを使用する
+1. 大文字を使うキャメルケースやパスカルケースは使用禁止
+
+| OK/NG | 名前            |
+| ----- | --------------- |
+| :o:   | **table\_name** |
+| :x:   | tableName       |
+| :x:   | TableName       |
+| :x:   | tablename       |
+| :x:   | table-name      |
+
+### 英語表記
+1. 基本的に単語はローマ字ではなく、英語で書く
+
+### 略名を使用しない
+1. 短くして意味が分からくなるよりは長くて意味がわかる名前にする
+1. ただし、データベースの種類や環境によって文字数が制限される場合は除く
+1. 以下は例外とする
+    1. "数"に関する項目は `_qty` (Quantityの略)を付ける
+    1. 例: `minus_points_qty`
+
+| OK/NG | 名前            |
+| ----- | --------------- |
+| :o:   | **start\_date** |
+| :o:   | **maker\_code** |
+| :x:   | start_dt        |
+| :x:   | maker_cd        |
+
+### テーブル編
+#### 単数形で書く
+
+| OK/NG | 名前         |
+| ----- | ------------ |
+| :o:   | **document** |
+| :x:   | documents    |
+| :o:   | **category** |
+| :x:   | categories   |
+
+#### n:n用テーブル
+1. 接頭語に`map_`を付ける
+
+| OK/NG | 名前                  |
+| ----- | --------------------- |
+| :o:   | **map_user_category** |
+| :x:   | user_category         |
+
+### カラム編
+1. ステータスを保存する項目は状態を含めて書く
+
+| OK/NG | 名前           |
+| ----- | -------------- |
+| :o:   | **is_working** |
+| :o:   | **is_deleted** |
+| :x:   | delete_flag    |
+
+#### flg、kbnなどの略名を使用しない
+1. 例えば"flag"と付いたboolean型にした場合、trueとfalseが見ただけでどちらがonなのかが分からないため
+
+| OK/NG | 名前           |
+| ----- | -------------- |
+| :o:   | **is_deleted** |
+| :x:   | delete_flg     |
+| :x:   | delete_flag    |
+
+### 制約編
+1. ユニーク制約は「テーブル名\_uq\_nn」とする
+1. `_uq` は固定文字。 `nn`はゼロ埋めの連番
+1. 例: `user_uq_01`
+
+### インデックス編
+1. インデックスは「テーブル名\_idx\_nn」とする
+1. `_idx` は固定文字。 `nn`はゼロ埋めの連番
+1. 例: `user_idx_01`