コンテンツにスキップ

システムの調査・実装用のドキュメント

1. 調査

本アプリケーションはマルチリポジトリのうちの一つのリポジトリです。

親ディレクトリに移動 (cd ../) し、関連コンポーネントのコンテキストを集めて。

たとえば、次のことです。

  • どんな関連コンポーネントがいるか
  • 関連コンポーネント間はどのようなAPIで連携しているか
  • 本アプリケーションの既存アーキテクチャ、レイヤーの種類、独自の慣習はなに?

2. 要件の収集

ここでは、現在の課題や要件を私に求めて欲しい。私から伝えます。

3. おおまかな設計の計画

ここでは、要件を満たす設計を模索してください。

バックエンド領域は可能な限りデータを加工する責務を持ち、フロントエンド領域ではそれを表示するだけの責務になるように、設計を模索して。

ただ、すべての加工処理をバックエンドで実施するのではなく、フロントエンドで実施するべき加工処理はフロントエンドで実施して。

例えば、次のロジックはフロントエンド領域におくべき。括弧内には、クリーンアーキテクチャのフロントエンド領域に関するパターン名を記載している。

  • データ型からUI表示書式への変換 (Presenter)
  • 取得データのUI展開、取得データに依存する分岐(View)

4. 機能と非機能の

ここでは、機能と非機能の設計で考慮して欲しいことを私に求めて欲しい。私から伝えます。

5. 実装方法の計画

ここでは、実装方法を提案してください。

  • 実装量が最も少なくなる方法を提案してください
  • 既存の実装方法に沿った実装方法を提案してください
  • 何かを命名する時は、動詞、助詞、名詞、形容詞を正しい順番で並べてください。
  • 三項演算子は使わないこと
  • 型推論できる言語では、インラインによる型定義を使用すること

6. 最後に

  • 何か欲しい情報があれば、教えてください。
  • お願いされた実装の完了後、自身の実装によってコンパイルエラーが新しく起こっていないかを確認して。