貢献ガイドライン¶
この設計レビューガイドをより良くするために時間を割いてくださり、ありがとうございます 本リポジトリは 明快で、主観を最小限に抑えた設計観点フレームワーク を目指しています 「チェックリスト」ではなく「思考ツール」です 構造と思想を守るためにいくつかルールを定めていますが、気軽に PR を出してもらえるとうれしいです
✅ 望ましい変更¶
- 新しい観点ファイル
- テンプレートに沿って
.md
ファイルを追加してください。 - ポイント: > この観点はどんな設計上のジレンマを扱うか?
- 既存観点の改善
- 表現の明瞭化、例や図の追加、背景説明の強化
- FAQの追加
- 設計レビューや障害対応でよく議論になる疑問を補完
- 関連観点のリンク追加
観点同士のつながりを強化するリンク - 翻訳
docs/ja/
のようにサブフォルダで整理してください- AI支援による草案(要レビュー)
- ChatGPT等で下書きしても構いませんが、最終的には人のレビューをお願いします
- 軽微な内容補足
開発者がつまずきそうな箇所を一言補う、などなど - GitHub ワークフローのちょい改善
mkdocs.yml
の調整、GitHub Pages 設定、CI、CLI関連ツールの追加などは歓迎(作者はこの辺疎いので)
🚫 原則マージしない変更¶
以下は原則としてマージしません MITなので自由にForkし改変してください
- 設計観点・構造の抜本的書き換え
- チュートリアルや教科書化
- プロジェクトの設計思想と異なる枠組みの提案
- SEOやプロモーション目的、ベンダー固有パターンの投稿
- 未編集のAI出力
🧭 貢献の原則¶
このプロジェクトは「構造的」ではありますが「独善的」なものではありません
- ✳️ 実案件に基づく具体的な設計判断や教訓
実際の障害対応やトレードオフ判断に基づく洞察を歓迎します ただし、それが特定の技術に閉じない 普遍的な観点として再構成されていることが前提です
- 読者の理解を助ける、表現スタイルの多様性
- 類似観点であっても、異なるトレードオフを扱うもの
- 命名や構文ではなく、「設計上の判断と背景」に関する拡張
✍️ 文体・明瞭性・敬意¶
次のような文体が望ましいです
- 表面の綺麗さより明瞭な論点
- 洒落た言葉より正確な意図
- 目新しさより実用的な洞察
🤝 コミュニケーションのお願い¶
- お互いリスペクトを忘れずに 🕊️
- 作者は純日本人なので英語はAIパワーで書いていますが、日本語でのコミュニケーションは結構できます
🛠 ローカルプレビュー(開発者向け)¶
```bash pip install \ mkdocs-material \ mkdocs-awesome-pages-plugin \ mkdocs-git-revision-date-localized-plugin mkdocs serve --config-file mkdocs.ja.yml