Skip to main content

Selection

Overview

開発における「選定のセクション」を追加することで、開発に必要な技術やツールの選定プロセス、評価基準、推奨される選択肢などをまとめることができます。
このセクションは、開発者がプロジェクトで使用する技術スタックやツールを決定する際に非常に有用です。

開発における「選定のセクション」を追加することで、開発に必要な技術やツールの選定プロセス、評価基準、推奨される選択肢などをまとめることができます。このセクションは、開発者がプロジェクトで使用する技術スタックやツールを決定する際に非常に有用です。

1. セクション名の選定

  • Selection(選定)
  • Tech Stack Selection(技術スタックの選定)
  • Tooling and Technology Selection(ツールおよび技術の選定)

2. セクションの構成例

以下に、選定に関するセクションの構成例を示します。このセクションは development の中に設置するのが自然でしょう。

例: selection セクションの構成

docs/
├── development/
│ ├── selection/
│ │ ├── introduction.md # 選定の基本方針
│ │ ├── frontend-framework.md # フロントエンドフレームワークの選定基準と比較
│ │ ├── backend-framework.md # バックエンドフレームワークの選定基準と比較
│ │ ├── database.md # データベースの選定基準と比較
│ │ ├── dev-tools.md # 開発ツールの選定
│ │ └── cloud-platforms.md # クラウドプラットフォームの選定
│ └── ... # 他の開発関連カテゴリ

3. セクションの内容

各ファイルには、以下のような情報を含めることが考えられます。

  • introduction.md:

    • このセクションの目的と、技術選定の重要性。
    • 技術選定の際に考慮すべき主要な要因(パフォーマンス、スケーラビリティ、チームのスキルセット、コストなど)。
  • frontend-framework.md:

    • React, Vue, Angularなど、主要なフロントエンドフレームワークの比較。
    • 各フレームワークの強みと弱み、使用例、推奨されるプロジェクトタイプ。
  • backend-framework.md:

    • Spring Boot, Django, Expressなどのバックエンドフレームワークの選定基準。
    • 各フレームワークのパフォーマンス、拡張性、コミュニティサポートの比較。
  • database.md:

    • RDBMS(PostgreSQL, MySQL)とNoSQL(MongoDB, Cassandra)の選定基準。
    • データベースの一貫性モデル、スケーラビリティ、用途に応じた選択肢の推奨。
  • dev-tools.md:

    • IDE, バージョン管理システム、CI/CDツール、テストフレームワークなどの選定。
    • ツールの統合性、生産性向上のためのベストプラクティス。
  • cloud-platforms.md:

    • AWS, GCP, Azureなどのクラウドプラットフォームの比較。
    • 各プラットフォームの強み、サービスの種類、コスト、地域サポートなど。

4. 他のセクションとのリンク

選定のセクション内で言及されている技術やツールが他のセクションで詳しく説明されている場合、リンクを張ってドキュメント全体の連携を強化します。

まとめ

  • selection セクションは、技術やツールの選定プロセスに関する情報を整理する場所として最適です。
  • 開発者がプロジェクトの技術スタックを決定する際に参考になるよう、明確な基準と比較情報を提供します。
  • 他のセクションとリンクさせることで、ドキュメント全体の一貫性と参照性を向上させます。

このセクションを追加することで、プロジェクトの技術選定がより効率的に行えるようになり、開発の品質向上にも寄与するでしょう。