操作
バグ #141
未完了【試験と報告書作成】Redmineドキュメント機能のAPI連携
ステータス:
新規
優先度:
通常
担当者:
-
開始日:
2025-06-02
期日:
進捗率:
0%
予定工数:
説明
試験と報告書作成¶
実施内容¶
- 受け入れテスト計画策定
- 受け入れテスト実施
- 試験結果レポート作成
- 操作マニュアル作成
- 技術ドキュメント作成
受け入れテスト計画¶
テスト項目¶
-
基本機能テスト
- チケット紐づきドキュメント登録機能
- 独立ドキュメント登録機能
- ドキュメント検索機能
- ドキュメント削除機能
-
UI連携テスト
- task.call2arm.comからのAPI呼び出し
- エラーハンドリング
- UX評価
-
負荷テスト
- 同時アクセス
- 大容量ファイル処理
-
運用テスト
- 長期安定性
- バックアップ・リストア
- ログローテーション
報告書作成計画¶
試験結果レポート¶
- テスト項目と結果
- 発見された問題と対応
- 性能測定結果
- 改善提案
操作マニュアル¶
- API利用方法
- エンドポイント一覧
- リクエスト/レスポンス例
- エラーコード一覧
- トラブルシューティング
技術ドキュメント¶
- システム構成図
- モジュール構成
- クラス図
- シーケンス図
- 設定パラメータ一覧
- デプロイ手順
- 保守手順
進捗状況¶
- 受け入れテスト計画: 50% 完了
- 基本テスト項目定義済み
- UI連携テスト計画中
- 受け入れテスト実施: 未実施
- 試験結果レポート: 未着手
- 操作マニュアル: 10% 完了
- 目次と基本構成のみ作成
- 技術ドキュメント: 30% 完了
- システム構成図作成済み
- モジュール構成図作成済み
- 他は未着手
Redmine Admin さんが3日前に更新
試験と報告書作成の進捗¶
チケットの種別を「バグ」から「機能」に変更しました。
現在の進捗状況(15%完了)¶
-
受け入れテスト計画策定(50%完了)
- ✅ 基本機能テスト項目定義
- 🔄 UI連携テスト計画(作成中)
- 🔄 負荷テスト計画(作成中)
- ❌ 運用テスト計画(未着手)
-
受け入れテスト実施(0%完了)
- ❌ 基本機能テスト(未着手)
- ❌ UI連携テスト(未着手)
- ❌ 負荷テスト(未着手)
- ❌ 運用テスト(未着手)
-
試験結果レポート(0%完了)
- ❌ テスト結果まとめ(未着手)
- ❌ 問題点と対策(未着手)
- ❌ 改善提案(未着手)
-
操作マニュアル(10%完了)
- ✅ 目次と構成(作成済み)
- 🔄 API概要説明(作成中)
- ❌ エンドポイント詳細(未着手)
- ❌ エラーコード一覧(未着手)
- ❌ サンプルコード(未着手)
-
技術ドキュメント(30%完了)
- ✅ システム構成図(作成済み)
- ✅ モジュール構成図(作成済み)
- 🔄 クラス図(作成中)
- ❌ シーケンス図(未着手)
- ❌ 設定パラメータ一覧(未着手)
- ❌ 保守手順(未着手)
今週の作業タスク¶
- 受け入れテスト計画の完成
- 操作マニュアルのAPI概要説明部分の完成
- クラス図の完成
- 設定パラメータ一覧の作成開始
ドキュメント作成方針¶
- 開発者向けと管理者向けのドキュメントを分離
- API仕様はOpenAPI形式で自動生成
- エンドユーザー向けの簡易マニュアルも作成
- サンプルコードを充実させる
実装と試験の進捗に合わせて、ドキュメント作成を並行して進めています。FastAPIの自動ドキュメント生成機能を活用して、API仕様書の作成効率を高めています。
操作