品質ガイドライン
Quality Guideline
AIGENT ACE株式会社が提供するすべてのサービスにおいて
遵守する品質基準と開発ガイドラインをご紹介します。
品質に対する考え方
私たちは「動けばいい」という考え方を否定します。 クライアントの事業成長を支えるシステムは、保守性・拡張性・セキュリティが 高い水準で担保されている必要があります。
AIGENT ACE株式会社では、全プロジェクトにおいて以下のガイドラインを遵守し、 「長く使えるシステム」を提供することをお約束します。
7つの品質基準
すべてのプロジェクトで必ず遵守する基準
コード品質
- check_circle 可読性の高いクリーンコード
- check_circle コメント・ドキュメントの整備
- check_circle 一貫した命名規則の適用
- check_circle DRY原則の徹底
テスト品質
- check_circle 単体テストのカバレッジ80%以上
- check_circle 結合テストの実施
- check_circle E2Eテストの実施(必要に応じて)
- check_circle テストの自動化
セキュリティ
- check_circle OWASP Top 10への対応
- check_circle SQLインジェクション対策
- check_circle XSS対策
- check_circle 認証・認可の適切な実装
パフォーマンス
- check_circle 初期表示3秒以内
- check_circle Lighthouse Score 80以上
- check_circle N+1問題の排除
- check_circle 適切なキャッシュ戦略
アクセシビリティ
- check_circle WCAG 2.1 AA準拠
- check_circle キーボード操作対応
- check_circle スクリーンリーダー対応
- check_circle 適切なコントラスト比
ドキュメント
- check_circle API仕様書の整備
- check_circle システム構成図の作成
- check_circle 運用マニュアルの作成
- check_circle 引き継ぎ資料の整備
保守性
- check_circle CI/CDパイプラインの構築
- check_circle 監視・アラート設定
- check_circle ログ設計の適正化
- check_circle 障害対応手順の整備
開発プロセス
品質を担保するための開発フロー
要件定義
目的・ゴールの明確化、スコープ定義
設計
アーキテクチャ設計、DB設計、API設計
実装
テスト駆動開発、コードレビュー必須
テスト
単体・結合・総合テスト、負荷テスト
リリース
ステージング検証、本番デプロイ、監視
コードレビュー基準
すべてのコードは以下の観点でレビューを実施
機能性
要件通りに動作するか、エッジケースは考慮されているか
可読性
変数名・関数名は適切か、コメントは必要十分か
効率性
パフォーマンスに問題はないか、無駄な処理はないか
安全性
セキュリティ上の脆弱性はないか、入力値検証は適切か
保守性
変更に強い設計か、テストは書かれているか
推奨技術スタック
実績と安定性を重視した技術選定