~UIドキュメントの改善・Spring×jQuery設計整備・Java移行対応を通して~
2025年は、UI設計やドキュメント整備のような“見える品質”を高める活動に重点を置きました。
特に、ドキュメント粒度の統一や実装と仕様の整合性維持、Java化に向けた基盤整備が主要なテーマとなりました。
今年実施した作業
- UI仕様書の修正、およびドキュメント粒度の統一
- Spring・jQueryでリリースするマニュアルドキュメントの作成
- 上記プロジェクトをベースに、ASP構成をJava化(基本設計~単体テスト[ブラックボックステスト])
- リリース後の問い合わせ等 (11月中期以降予定)
DB環境
- PostgreSQL
今年1年を通して改めてわかったこと
システムを安定的にリリースするには、「UIの仕様精度」と「ドキュメント整合性」が欠かせない。
ドキュメント粒度調整や命名規則の統一が、後工程のバグ削減に大きく寄与する。
改善に効果のあった進め方
- UI仕様書と画面設計の差異を週次レビューで確認
- jQueryイベントハンドラや画面IDルールを共通化
- SpringのController層・View層間での命名連動を整理し、コード自動生成との整合性も確保
ドキュメント管理・共有の工夫
- PlantUML による設計書に導入
- Excelベースのドキュメントをコード連携化
- レビュー時にCopilotを補助利用して文面チェック・構成整備を実施
Java移行プロジェクトでの工夫点
ASP→Javaリプレースのポイント
- 共通関数群の洗い出しと、Spring構成への共通化設計
- jQueryイベント制御とJava側バリデーション整合調整
- Java移行後も「ベースのUI操作感を崩さない」方針で設計対応
- BlackBoxテストでは、I/Oのデータのフラグを基にして、API確認を効率化
使用技術とツール
| カテゴリ | 使用技術・ツール |
|---|---|
| バックエンド | Spring Boot 3.x, Lombok, Doma2, PostgreSQL |
| フロント | jQuery, Bootstrap, Thymeleaf |
| テスト | curl, マトリクス表PCL |
| 管理 | Redmine, Teams |
反省点
- 複雑な仕様の理解が追いつかない部分があった
- Teamsで無駄にメンション飛びを多くしてしまった
- 同じチーム内(3名)で役割分担を変えながら進め、無事リリース・納品まで完了
- もっと案件のベース理解や要件整理、基本設計段階でのチームコミュニケーション時間を多く確保すべきだった
→ 今後は、対面での会議をもっと増やして、認識合わせをホワイトボード等も使って行う。初期段階の情報共有・認識合わせをさらに重視し、仕様理解の齟齬や誤解を未然に防ぐ取り組みを強化したい。
今後力をいれたいところ
- API設計ドキュメント生成をOpenAPIに統一し、設計の自動化・共有を強化
- Postman+JUnitのテストツールを併用した「ホワイトボックステスト」でいきたい
- Spring BootとReactの連携実証を実施し、ビルド自動化環境(Gradle+GitHub Actions)を検証
- CopilotやChatGPTを活用し、作業粒度とドキュメント体系の標準化を継続的に推進
2025年でGoogle検索したトレンド技術キーワード
| カテゴリ | トレンド内容 |
|---|---|
| Spring | Boot 3.3 ・ Virtual Thread ・ Lombok制約改訂 |
| UI | jQuery依存削減 ・ React / Vanilla Extract 移行準備 |
| ドキュメント | Markdown+Mermaidで設計統一化 |
| テスト | JUnit5+Mockito+Postman自動テスト連携 |
| 自動化 | GitHub Actions、Copilotによるコードレビュー支援 |