Skip to content

docs(dev): 新 feature 追加時のテンプレ手順書 docs/dev/feature-template.md 整備 (N4 / C) #274

Description

@win2cot

A-1/A-2/B で整えた 4 層構造を、新 feature 追加時に再現できるように テンプレ手順書 docs/dev/feature-template.md を整備する。

N4 (#86) を 4 分割した C スコープ:

やること

1. docs/dev/feature-template.md 新規作成

新 feature 追加時の手順を網羅:

  • パッケージ構造(<feature>/domain / usecase / adapter/web / adapter/persistence / adapter/external / infra)
  • package-info.java テンプレ(@NullMarked)
  • shared / @ApplicationModule(type = Type.OPEN) の参照ルール(ADR-0003)
  • ApplicationModules.verify() テスト追加方針
  • @Transactional 境界明示(コーディング規約 §11)
  • DTO / Controller / UseCase / Port / Adapter の責務境界
  • B (backend: 基盤(shared/exception + Task POJO/JPA Entity 分離 + Repository ポート) (N4 / B-1) #273) GET /tasks/{id} を参照実装として明示

2. 設計規約 §1.1 / ADR-0003 への cross-reference

  • docs/specs/設計規約.md §1.1 に docs/dev/feature-template.md への cross-ref を追記
  • docs/adr/0003-shared-package-as-open-module.mddocs/dev/feature-template.md への cross-ref を追記

3. commit message に cross-reference

  • Refs: docs/specs/設計規約.md §1.1
  • Refs: docs/adr/0003-shared-package-as-open-module.md

やらないこと

  • ArchUnit 導入の記載 → ADR-0002 保留中、cross-ref のみ
  • README.md トップへの参照追加 → 別 Issue
  • docs/dev/ index 作成 → 別 Issue

受け入れ条件

参照

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/docsdocs/ 配下のドキュメント(設計書・規約・ADR 等)変更priority/p2Medium。完了が望ましいが柔軟に判断可

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions