devendra-skill-package 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/skills/boiler-project-generator/SKILL.md +103 -0
- package/.github/skills/boiler-project-generator/assets/templates/android/README.md +3 -0
- package/.github/skills/boiler-project-generator/assets/templates/angular/README.md +3 -0
- package/.github/skills/boiler-project-generator/assets/templates/flutter/README.md +3 -0
- package/.github/skills/boiler-project-generator/assets/templates/ios/README.md +3 -0
- package/.github/skills/boiler-project-generator/assets/templates/react/README.md +3 -0
- package/.github/skills/boiler-project-generator/assets/templates/react-native/README.md +3 -0
- package/.github/skills/boiler-project-generator/assets/templates/react-native/api-setup.ts +76 -0
- package/.github/skills/boiler-project-generator/assets/templates/react-native/component-primary-button.tsx +29 -0
- package/.github/skills/boiler-project-generator/assets/templates/react-native/env-config.env +4 -0
- package/.github/skills/boiler-project-generator/assets/templates/react-native/feature-auth-screen.tsx +45 -0
- package/.github/skills/boiler-project-generator/assets/templates/react-native/feature-dashboard-screen.tsx +45 -0
- package/.github/skills/boiler-project-generator/assets/templates/react-native/feature-profile-screen.tsx +45 -0
- package/.github/skills/boiler-project-generator/assets/templates/react-native/hook-use-app-boot.ts +11 -0
- package/.github/skills/boiler-project-generator/assets/templates/react-native/navigation-setup.tsx +25 -0
- package/.github/skills/boiler-project-generator/assets/templates/react-native/project-structure.md +24 -0
- package/.github/skills/boiler-project-generator/assets/templates/react-native/redux-hooks.ts +5 -0
- package/.github/skills/boiler-project-generator/assets/templates/react-native/redux-session-slice.ts +29 -0
- package/.github/skills/boiler-project-generator/assets/templates/react-native/redux-store.ts +15 -0
- package/.github/skills/boiler-project-generator/assets/templates/react-native/theme-index.ts +23 -0
- package/.github/skills/boiler-project-generator/assets/templates/react-native/utils-helpers.ts +7 -0
- package/.github/skills/boiler-project-generator/metadata.yaml +29 -0
- package/.github/skills/boiler-project-generator/references/android.md +19 -0
- package/.github/skills/boiler-project-generator/references/angular.md +14 -0
- package/.github/skills/boiler-project-generator/references/flutter.md +17 -0
- package/.github/skills/boiler-project-generator/references/ios.md +17 -0
- package/.github/skills/boiler-project-generator/references/react-native.md +103 -0
- package/.github/skills/boiler-project-generator/references/react.md +17 -0
- package/.github/skills/boiler-project-generator/scripts/angular.js +43 -0
- package/.github/skills/boiler-project-generator/scripts/generate-project.mjs +107 -0
- package/.github/skills/boiler-project-generator/scripts/init.js +105 -0
- package/.github/skills/boiler-project-generator/scripts/react-native.js +1041 -0
- package/.github/skills/boiler-project-generator/scripts/react.js +32 -0
- package/.github/skills/clean-architecture-generator/SKILL.md +235 -0
- package/.github/skills/clean-architecture-generator/references/architecture-core.md +126 -0
- package/.github/skills/clean-architecture-generator/references/platform-angular.md +374 -0
- package/.github/skills/clean-architecture-generator/references/platform-flutter.md +366 -0
- package/.github/skills/clean-architecture-generator/references/platform-react-native.md +590 -0
- package/.github/skills/clean-architecture-generator/references/platform-react.md +261 -0
- package/.github/skills/code-test-coverage-analyzer/SKILL.md +1358 -0
- package/.github/skills/code-test-coverage-analyzer/assets/config-questionnaire.md +118 -0
- package/.github/skills/code-test-coverage-analyzer/assets/conflict-resolution-protocol.md +99 -0
- package/.github/skills/code-test-coverage-analyzer/assets/coverage-calculation-rules.md +294 -0
- package/.github/skills/code-test-coverage-analyzer/assets/multi-strategy-search.md +145 -0
- package/.github/skills/code-test-coverage-analyzer/assets/output-file-contracts.md +651 -0
- package/.github/skills/code-test-coverage-analyzer/assets/status-definitions.md +273 -0
- package/.github/skills/code-test-coverage-analyzer/examples/example-invocation.md +208 -0
- package/.github/skills/code-test-coverage-analyzer/references/android-patterns.md +229 -0
- package/.github/skills/code-test-coverage-analyzer/references/angular-patterns.md +177 -0
- package/.github/skills/code-test-coverage-analyzer/references/backend-patterns.md +383 -0
- package/.github/skills/code-test-coverage-analyzer/references/flutter-patterns.md +254 -0
- package/.github/skills/code-test-coverage-analyzer/references/ios-patterns.md +228 -0
- package/.github/skills/code-test-coverage-analyzer/references/react-native-patterns.md +431 -0
- package/.github/skills/code-test-coverage-analyzer/references/react-patterns.md +206 -0
- package/.github/skills/code-test-coverage-analyzer/scripts/detect-platform.ps1 +261 -0
- package/.github/skills/code-test-coverage-analyzer/scripts/scan-repository.ps1 +242 -0
- package/.github/skills/code-test-coverage-analyzer/templates/brd-compliance-row.md +107 -0
- package/.github/skills/code-test-coverage-analyzer/templates/test-case-row.md +130 -0
- package/.github/skills/code-test-coverage-analyzer/templates/user-story-compliance-row.md +170 -0
- package/.github/skills/custom-font-integrator/SKILL.md +373 -0
- package/.github/skills/custom-font-integrator/assets/FontTestScreen.js +150 -0
- package/.github/skills/custom-font-integrator/references/example-info-plist.xml +21 -0
- package/.github/skills/custom-font-integrator/scripts/setup-fonts.sh +99 -0
- package/.github/skills/encryption-decryption-utility/Instructions.md +282 -0
- package/.github/skills/encryption-decryption-utility/README.md +222 -0
- package/.github/skills/encryption-decryption-utility/SKILL.md +645 -0
- package/.github/skills/encryption-decryption-utility/assets/encryption-config-template.json +13 -0
- package/.github/skills/encryption-decryption-utility/assets/platform-matrix.json +180 -0
- package/.github/skills/encryption-decryption-utility/metadata.yaml +51 -0
- package/.github/skills/encryption-decryption-utility/references/android-crypto.md +157 -0
- package/.github/skills/encryption-decryption-utility/references/angular-crypto.md +130 -0
- package/.github/skills/encryption-decryption-utility/references/approach-1-webcrypto.md +95 -0
- package/.github/skills/encryption-decryption-utility/references/approach-2-rsa-aes-cbc.md +111 -0
- package/.github/skills/encryption-decryption-utility/references/approach-3-aes-sharedkey.md +114 -0
- package/.github/skills/encryption-decryption-utility/references/architecture.md +233 -0
- package/.github/skills/encryption-decryption-utility/references/backend-alignment.md +506 -0
- package/.github/skills/encryption-decryption-utility/references/dependency-guidance.md +234 -0
- package/.github/skills/encryption-decryption-utility/references/ec-implementation.md +832 -0
- package/.github/skills/encryption-decryption-utility/references/error-handling-playbook.md +234 -0
- package/.github/skills/encryption-decryption-utility/references/flutter-crypto.md +105 -0
- package/.github/skills/encryption-decryption-utility/references/ios-crypto.md +338 -0
- package/.github/skills/encryption-decryption-utility/references/native-rsa-implementation.md +373 -0
- package/.github/skills/encryption-decryption-utility/references/node-crypto.md +86 -0
- package/.github/skills/encryption-decryption-utility/references/react-crypto.md +105 -0
- package/.github/skills/encryption-decryption-utility/references/react-native-crypto.md +1001 -0
- package/.github/skills/encryption-decryption-utility/references/react-web-crypto.md +668 -0
- package/.github/skills/encryption-decryption-utility/references/security-checklist.md +176 -0
- package/.github/skills/encryption-decryption-utility/references/web-crypto.md +74 -0
- package/.github/skills/encryption-decryption-utility/scripts/detect.js +128 -0
- package/.github/skills/encryption-decryption-utility/scripts/install.js +1713 -0
- package/.github/skills/encryption-decryption-utility/scripts/setup.js +800 -0
- package/.github/skills/encryption-decryption-utility/template.md +241 -0
- package/.github/skills/encryption-decryption-utility/templates/config-questionnaire.md +467 -0
- package/.github/skills/encryption-decryption-utility/templates/delivery-checklist.md +206 -0
- package/.github/skills/encryption-decryption-utility/templates/implementation-plan.md +304 -0
- package/.github/skills/feature-generator/SKILL.MD +2741 -0
- package/.github/skills/feature-generator/assets/fingerprint-schema.json +385 -0
- package/.github/skills/feature-generator/assets/spec-template.md +172 -0
- package/.github/skills/feature-generator/assets/transform-rules.json +82 -0
- package/.github/skills/feature-generator/references/api-envelope-patterns.md +327 -0
- package/.github/skills/feature-generator/references/screen-logic-patterns.md +399 -0
- package/.github/skills/feature-generator/references/state-library-patterns.md +464 -0
- package/.github/skills/figma-ui-mapper/README.md +34 -0
- package/.github/skills/figma-ui-mapper/SKILL.md +101 -0
- package/.github/skills/figma-ui-mapper/assets/templates/component-map-template.md +30 -0
- package/.github/skills/figma-ui-mapper/assets/templates/generation-report-template.md +49 -0
- package/.github/skills/figma-ui-mapper/metadata.yaml +22 -0
- package/.github/skills/figma-ui-mapper/references/android.md +11 -0
- package/.github/skills/figma-ui-mapper/references/angular.md +18 -0
- package/.github/skills/figma-ui-mapper/references/capacitor.md +18 -0
- package/.github/skills/figma-ui-mapper/references/common.md +23 -0
- package/.github/skills/figma-ui-mapper/references/expo.md +18 -0
- package/.github/skills/figma-ui-mapper/references/flutter.md +18 -0
- package/.github/skills/figma-ui-mapper/references/frameworks/angular/rules.md +23 -0
- package/.github/skills/figma-ui-mapper/references/frameworks/capacitor/rules.md +23 -0
- package/.github/skills/figma-ui-mapper/references/frameworks/expo/rules.md +23 -0
- package/.github/skills/figma-ui-mapper/references/frameworks/flutter/rules.md +23 -0
- package/.github/skills/figma-ui-mapper/references/frameworks/ionic/rules.md +23 -0
- package/.github/skills/figma-ui-mapper/references/frameworks/kotlin-multiplatform/rules.md +23 -0
- package/.github/skills/figma-ui-mapper/references/frameworks/native-android/rules.md +23 -0
- package/.github/skills/figma-ui-mapper/references/frameworks/native-ios/rules.md +23 -0
- package/.github/skills/figma-ui-mapper/references/frameworks/next/rules.md +23 -0
- package/.github/skills/figma-ui-mapper/references/frameworks/nuxt/rules.md +23 -0
- package/.github/skills/figma-ui-mapper/references/frameworks/react/rules.md +19 -0
- package/.github/skills/figma-ui-mapper/references/frameworks/react-native/rules.md +23 -0
- package/.github/skills/figma-ui-mapper/references/frameworks/svelte/rules.md +23 -0
- package/.github/skills/figma-ui-mapper/references/frameworks/vue/rules.md +23 -0
- package/.github/skills/figma-ui-mapper/references/ionic.md +18 -0
- package/.github/skills/figma-ui-mapper/references/ios.md +11 -0
- package/.github/skills/figma-ui-mapper/references/kotlin-multiplatform.md +18 -0
- package/.github/skills/figma-ui-mapper/references/native-android.md +18 -0
- package/.github/skills/figma-ui-mapper/references/native-ios.md +18 -0
- package/.github/skills/figma-ui-mapper/references/next.md +18 -0
- package/.github/skills/figma-ui-mapper/references/nuxt.md +18 -0
- package/.github/skills/figma-ui-mapper/references/react-figma-guideline.md +21 -0
- package/.github/skills/figma-ui-mapper/references/react-native.md +18 -0
- package/.github/skills/figma-ui-mapper/references/react.md +18 -0
- package/.github/skills/figma-ui-mapper/references/script-usage.md +46 -0
- package/.github/skills/figma-ui-mapper/references/svelte.md +18 -0
- package/.github/skills/figma-ui-mapper/references/vue.md +18 -0
- package/.github/skills/figma-ui-mapper/references/workflow.md +74 -0
- package/.github/skills/figma-ui-mapper/scripts/generate-page-through-figma.js +635 -0
- package/.github/skills/figma-ui-mapper/scripts/generate-react-page-through-figma.js +4 -0
- package/.github/skills/frontend-task-breakdown/SKILL.md +734 -0
- package/.github/skills/md-file-converter/SKILL.md +291 -0
- package/.github/skills/md-file-converter/config/formats.json +114 -0
- package/.github/skills/md-file-converter/extractors/extract-docx.sh +120 -0
- package/.github/skills/md-file-converter/extractors/extract-eml.py +108 -0
- package/.github/skills/md-file-converter/extractors/extract-pdf.sh +97 -0
- package/.github/skills/md-file-converter/extractors/extract-pptx.py +143 -0
- package/.github/skills/md-file-converter/extractors/extract-xlsx.py +175 -0
- package/.github/skills/md-file-converter/scripts/check-tools.sh +47 -0
- package/.github/skills/md-file-converter/scripts/extract-archive.sh +83 -0
- package/.github/skills/md-file-converter/scripts/extract-ocr.sh +77 -0
- package/.github/skills/md-file-converter/scripts/get-metadata.sh +57 -0
- package/.github/skills/md-file-converter/templates/output.md +73 -0
- package/.github/skills/md-file-converter/templates/unsupported-object.md +6 -0
- package/.github/skills/mockAPI-contract-generator/SKILL.md +607 -0
- package/.github/skills/test-case-validator/CHANGELOG.md +155 -0
- package/.github/skills/test-case-validator/CONFIGURATION.md +130 -0
- package/.github/skills/test-case-validator/EXAMPLES.md +50 -0
- package/.github/skills/test-case-validator/QUALITY_SCORING.md +98 -0
- package/.github/skills/test-case-validator/README.md +111 -0
- package/.github/skills/test-case-validator/REPORT_TEMPLATE.md +116 -0
- package/.github/skills/test-case-validator/SKILL.md +209 -0
- package/.github/skills/test-case-validator/SYSTEM_PROMPT.md +127 -0
- package/.github/skills/test-case-validator/TRACEABILITY_ENGINE.md +152 -0
- package/.github/skills/test-case-validator/VALIDATION_RULES.md +411 -0
- package/.github/skills/test-case-validator/config/default.config.yaml +62 -0
- package/.github/skills/test-case-validator/docs/ARCHITECTURE.md +66 -0
- package/.github/skills/test-case-validator/docs/EXTENDING.md +85 -0
- package/.github/skills/test-case-validator/docs/FAQ.md +88 -0
- package/.github/skills/test-case-validator/docs/VERSIONING.md +55 -0
- package/.github/skills/test-case-validator/examples/example-1-manual-qa-ecommerce/input-brd.md +43 -0
- package/.github/skills/test-case-validator/examples/example-1-manual-qa-ecommerce/input-test-cases.csv +9 -0
- package/.github/skills/test-case-validator/examples/example-1-manual-qa-ecommerce/input-user-story.md +29 -0
- package/.github/skills/test-case-validator/examples/example-1-manual-qa-ecommerce/output-report.md +303 -0
- package/.github/skills/test-case-validator/examples/example-2-automated-frontend-suite/input-spec.md +43 -0
- package/.github/skills/test-case-validator/examples/example-2-automated-frontend-suite/input-test-files-index.md +56 -0
- package/.github/skills/test-case-validator/examples/example-2-automated-frontend-suite/output-report.md +274 -0
- package/.github/skills/test-case-validator/prompts/00-applicability-resolution.md +61 -0
- package/.github/skills/test-case-validator/prompts/01-extraction-user-story.md +58 -0
- package/.github/skills/test-case-validator/prompts/02-extraction-brd.md +64 -0
- package/.github/skills/test-case-validator/prompts/03-extraction-test-cases.md +92 -0
- package/.github/skills/test-case-validator/prompts/04-traceability-matrix.md +41 -0
- package/.github/skills/test-case-validator/prompts/05-coverage-analysis.md +46 -0
- package/.github/skills/test-case-validator/prompts/06-missing-scenario-detection.md +32 -0
- package/.github/skills/test-case-validator/prompts/07-duplicate-detection.md +36 -0
- package/.github/skills/test-case-validator/prompts/08-risk-analysis.md +39 -0
- package/.github/skills/test-case-validator/prompts/09-gated-wiring-validation.md +53 -0
- package/.github/skills/test-case-validator/prompts/10-observation-report.md +56 -0
- package/.github/skills/test-case-validator/prompts/11-final-report-assembly.md +57 -0
- package/.github/skills/test-case-validator/templates/coverage-table.md +25 -0
- package/.github/skills/test-case-validator/templates/executive-summary.md +38 -0
- package/.github/skills/test-case-validator/templates/final-summary-block.md +87 -0
- package/.github/skills/test-case-validator/templates/observation-entry.md +41 -0
- package/.github/skills/test-case-validator/templates/rtm-row.md +25 -0
- package/.github/skills/validation-engine-builder/README.md +50 -0
- package/.github/skills/validation-engine-builder/SKILL.md +241 -0
- package/.github/skills/validation-engine-builder/references/core.md +158 -0
- package/.github/skills/validation-engine-builder/references/platform-angular.md +166 -0
- package/.github/skills/validation-engine-builder/references/platform-flutter.md +118 -0
- package/.github/skills/validation-engine-builder/references/platform-react-native.md +170 -0
- package/.github/skills/validation-engine-builder/references/platform-react.md +94 -0
- package/.github/skills/validation-engine-builder/scripts/apply-to-project.js +80 -0
- package/.github/skills/validation-engine-builder/scripts/generate-angular.js +271 -0
- package/.github/skills/validation-engine-builder/scripts/generate-flutter.js +298 -0
- package/.github/skills/validation-engine-builder/scripts/generate-react-native.js +217 -0
- package/.github/skills/validation-engine-builder/scripts/generate-react.js +163 -0
- package/.github/skills/validation-engine-builder/scripts/install-deps.js +53 -0
- package/.github/skills/validation-engine-builder/scripts/shared/detect-platform.js +68 -0
- package/.github/skills/validation-engine-builder/scripts/shared/npm-deps.js +103 -0
- package/.github/skills/validation-engine-builder/scripts/shared/rhf-hook.js +43 -0
- package/.github/skills/validation-engine-builder/scripts/shared/ts-messages-regex.js +62 -0
- package/.github/skills/validation-engine-builder/scripts/shared/util.js +44 -0
- package/.github/skills/validation-engine-builder/scripts/shared/yup-schemas.js +80 -0
- package/.github/skills/validation-engine-builder/template.md +73 -0
- package/.github/skills/validation-engine-builder/templates/messages.json +22 -0
- package/.github/skills/validation-engine-builder/templates/regex.json +16 -0
- package/.github/skills/validation-engine-builder/templates/schemas.json +48 -0
- package/bin/index.js +145 -0
- package/package.json +22 -0
- package/readme.md +0 -0
|
@@ -0,0 +1,651 @@
|
|
|
1
|
+
# Output File Contracts — Project Requirements Compliance Auditor
|
|
2
|
+
|
|
3
|
+
This document defines the mandatory content, structure, and quality standards for each of the
|
|
4
|
+
15 output files. All files are generated inside the `{Q5}/` output folder at the project root.
|
|
5
|
+
|
|
6
|
+
Every file must:
|
|
7
|
+
- Use GitHub-flavored Markdown
|
|
8
|
+
- Contain no placeholder text (`[TODO]`, `[TBD]`, `[N/A]`)
|
|
9
|
+
- Contain no emojis
|
|
10
|
+
- Include a header with: Audit Date, Project Root, Platform, Skill Version: 3.0.0, and the file's purpose
|
|
11
|
+
- Be generated in this sequence (see §Global File Rules §Generation Order for rationale):
|
|
12
|
+
**Phase 1**: Files 02–11 (detail files, generated in any order within this phase)
|
|
13
|
+
**Phase 2**: File 12 (extra implementation — references detail file findings)
|
|
14
|
+
**Phase 3**: File 13 (scorecard — aggregates all detail file scores)
|
|
15
|
+
**Phase 4**: File 01 (executive summary — derived from scorecard; must be generated LAST of the numbered files)
|
|
16
|
+
**Phase 5**: Files 14–15 (recommendations and security — reference scorecard and detail files)
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## File 01 — 01_EXECUTIVE_SUMMARY.md
|
|
21
|
+
|
|
22
|
+
**Contract**: Single-page executive overview. Non-technical readers must understand the health of the project from this file alone.
|
|
23
|
+
|
|
24
|
+
**Required Sections** (in order):
|
|
25
|
+
1. `# Executive Summary` — project name, audit date, project root, platform
|
|
26
|
+
2. `## Overall Compliance Score` — the weighted score as a large ASCII visual (see format below)
|
|
27
|
+
3. `## Risk Score` — one of: CRITICAL | HIGH | MEDIUM | LOW | MINIMAL with color-equivalent markdown bold
|
|
28
|
+
4. `## Production Readiness` — one of: NOT READY | NEEDS WORK | CONDITIONAL | READY with rationale (1–2 sentences)
|
|
29
|
+
5. `## Coverage at a Glance` — summary table:
|
|
30
|
+
```
|
|
31
|
+
| Dimension | Total | Implemented | Partial | Missing | Coverage % |
|
|
32
|
+
|------------------------|-------|-------------|---------|---------|------------|
|
|
33
|
+
| BRD Requirements | | | | | |
|
|
34
|
+
| User Stories | | | | | |
|
|
35
|
+
| Acceptance Criteria | | | | | |
|
|
36
|
+
| Test Cases (Pass) | | | | | |
|
|
37
|
+
| Validations | | | | | |
|
|
38
|
+
| APIs | | | | | |
|
|
39
|
+
| UI Screens | | | | | |
|
|
40
|
+
| Business Logic Rules | | | | | |
|
|
41
|
+
| Navigation Flows | | | | | |
|
|
42
|
+
```
|
|
43
|
+
6. `## Critical Issues` — top 5 missing/incorrect items with BRD-ID or TC-ID
|
|
44
|
+
7. `## Key Risks` — 3–5 bullet points
|
|
45
|
+
8. `## Immediate Action Items` — 3–5 bullet points
|
|
46
|
+
9. `## Input Documents Audited` — table listing Q1, Q2, Q3 with requirement counts
|
|
47
|
+
|
|
48
|
+
**Score Visual Format**:
|
|
49
|
+
```
|
|
50
|
+
Overall Compliance: 73%
|
|
51
|
+
[====================> ] 73/100
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
**Allowed empty values**: None. All cells must be filled.
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## File 02 — 02_BRD_COMPLIANCE.md
|
|
59
|
+
|
|
60
|
+
**Contract**: Complete requirement-by-requirement BRD audit.
|
|
61
|
+
|
|
62
|
+
**Required Sections**:
|
|
63
|
+
1. `# BRD Compliance Report`
|
|
64
|
+
2. `## Summary` — counts table: Total | IMPLEMENTED | PARTIALLY_IMPLEMENTED | MISSING | INCORRECT | EXTRA | NOT_VERIFIED | CONFLICTED | SCOPED_OUT
|
|
65
|
+
3. `## Coverage Chart` — ASCII bar chart by category (see §Global Bar Chart Format)
|
|
66
|
+
4. `## Detailed Compliance — {Category Name}` (one section per BRD category)
|
|
67
|
+
5. `## Requirement Conflicts` — if any CONFLICTED items were detected during Step 2D, add this table:
|
|
68
|
+
| CONFLICT-ID | Entity | Source 1 | Value 1 | Source 2 | Value 2 | Contradiction Summary | Resolution Status |
|
|
69
|
+
If no conflicts detected, write "No requirement conflicts detected."
|
|
70
|
+
6. `## Deferred / Out of Scope` — list all SCOPED_OUT requirements (from Q8). If Q8 was empty: "None — all requirements in scope."
|
|
71
|
+
|
|
72
|
+
**Requirement Row Format** (table per category):
|
|
73
|
+
```
|
|
74
|
+
| BRD-ID | Priority | Requirement | Status | Coverage | Evidence | Issues | Recommendation |
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
**Rules**:
|
|
78
|
+
- Every BRD requirement must appear in exactly one category section
|
|
79
|
+
- Status must be one of the defined status values (all caps)
|
|
80
|
+
- Evidence must include file path and function/class name (or "None — not found")
|
|
81
|
+
- Issues column: empty string if IMPLEMENTED, otherwise specific gap description
|
|
82
|
+
- Recommendation column: empty string if IMPLEMENTED, otherwise actionable fix
|
|
83
|
+
|
|
84
|
+
**Sorting within each category**: MISSING first, then INCORRECT, then CONFLICTED, then PARTIALLY_IMPLEMENTED, then IMPLEMENTED
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## File 03 — 03_USER_STORY_COMPLIANCE.md
|
|
89
|
+
|
|
90
|
+
**Contract**: Story-by-story verification with per-acceptance-criterion breakdown.
|
|
91
|
+
|
|
92
|
+
**Required Sections**:
|
|
93
|
+
1. `# User Story Compliance Report`
|
|
94
|
+
2. `## Summary` — Total stories | Fully Satisfied | Partially Satisfied | Not Satisfied | Not Verifiable
|
|
95
|
+
3. `## Story {US-ID} — {Story Title}` (one section per story)
|
|
96
|
+
|
|
97
|
+
**Per-Story Block**:
|
|
98
|
+
```markdown
|
|
99
|
+
### Story US-XXX — {Story Title}
|
|
100
|
+
**Role**: As a {role}
|
|
101
|
+
**Goal**: I want to {goal}
|
|
102
|
+
**Value**: So that {value}
|
|
103
|
+
**Overall Status**: FULLY_SATISFIED | PARTIALLY_SATISFIED | NOT_SATISFIED | NOT_VERIFIABLE
|
|
104
|
+
|
|
105
|
+
#### Acceptance Criteria
|
|
106
|
+
| AC-ID | Criterion | Status | Evidence | Issues |
|
|
107
|
+
|-------|-----------|--------|----------|--------|
|
|
108
|
+
|
|
109
|
+
#### Business Flow Verification
|
|
110
|
+
| Aspect | Required | Implemented | Status | Evidence |
|
|
111
|
+
|--------|----------|-------------|--------|----------|
|
|
112
|
+
| Screen | | | | |
|
|
113
|
+
| API | | | | |
|
|
114
|
+
| Validation | | | | |
|
|
115
|
+
| Navigation | | | | |
|
|
116
|
+
| Error Handling | | | | |
|
|
117
|
+
| Loading State | | | | |
|
|
118
|
+
|
|
119
|
+
#### Missing Elements
|
|
120
|
+
{bullet list of what is missing, or "None — fully implemented"}
|
|
121
|
+
|
|
122
|
+
#### Recommendation
|
|
123
|
+
{specific action needed, or "No action required"}
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
**Rules**:
|
|
127
|
+
- Every AC must be assessed individually
|
|
128
|
+
- Evidence must reference the source file
|
|
129
|
+
- Missing Elements must be specific, not vague
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## File 04 — 04_TEST_CASE_COMPLIANCE.md
|
|
134
|
+
|
|
135
|
+
**Contract**: Every test case logically executed against the implementation.
|
|
136
|
+
|
|
137
|
+
**Required Sections**:
|
|
138
|
+
1. `# Test Case Compliance Report`
|
|
139
|
+
2. `## Summary` — Total | PASS | PARTIAL_PASS | FAIL | NOT_IMPLEMENTED | BLOCKED | UNKNOWN
|
|
140
|
+
3. `## Pass Rate` — ASCII bar chart
|
|
141
|
+
4. `## Critical Failures` — list of FAIL and NOT_IMPLEMENTED TCs with one-line reason each
|
|
142
|
+
5. `## Detailed Results — {TC-ID}` — one section per test case
|
|
143
|
+
|
|
144
|
+
**Per-Test-Case Format**:
|
|
145
|
+
```markdown
|
|
146
|
+
### TC-XXX — {Scenario Name}
|
|
147
|
+
**Type**: {Functional | Validation | Navigation | API | Business Logic | Edge Case | Negative}
|
|
148
|
+
**Related Story**: {US-ID or "None"}
|
|
149
|
+
**Related BRD**: {BRD-ID or "None"}
|
|
150
|
+
**Verdict**: PASS | PARTIAL_PASS | FAIL | NOT_IMPLEMENTED | BLOCKED | UNKNOWN
|
|
151
|
+
|
|
152
|
+
#### Test Steps vs Implementation
|
|
153
|
+
| Step | Action | Expected | Actual Implementation | Status |
|
|
154
|
+
|------|--------|----------|-----------------------|--------|
|
|
155
|
+
|
|
156
|
+
#### Evidence
|
|
157
|
+
- Files: {list of files read as evidence}
|
|
158
|
+
- Functions: {function names if applicable}
|
|
159
|
+
|
|
160
|
+
#### Reason
|
|
161
|
+
{Why this verdict was given — specific, not vague}
|
|
162
|
+
|
|
163
|
+
#### Recommendation
|
|
164
|
+
{What needs to be done to make this test pass, or "No action required"}
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
**Rules**:
|
|
168
|
+
- Never check for test file existence — check for feature implementation
|
|
169
|
+
- "Actual Implementation" must describe what the code does, not what the file is named
|
|
170
|
+
- BLOCKED tests must name the blocking dependency
|
|
171
|
+
|
|
172
|
+
**Sorting**: FAIL and NOT_IMPLEMENTED first, then BLOCKED, then PARTIAL_PASS, then UNKNOWN, then PASS last
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
|
|
176
|
+
## File 05 — 05_VALIDATION_ANALYSIS.md
|
|
177
|
+
|
|
178
|
+
**Contract**: Field-by-field, rule-by-rule validation audit with exact message comparison.
|
|
179
|
+
|
|
180
|
+
**Required Sections**:
|
|
181
|
+
1. `# Validation Analysis Report`
|
|
182
|
+
2. `## Summary` — Total required validations | Implemented | Missing | Message Mismatches
|
|
183
|
+
3. `## Validation Coverage by Screen` — table: Screen | Fields Required | Fields Validated | Coverage %
|
|
184
|
+
4. `## Detailed Validation Audit` — per-field analysis
|
|
185
|
+
|
|
186
|
+
**Per-Field Format**:
|
|
187
|
+
```markdown
|
|
188
|
+
#### Field: {fieldName} on {ScreenName}
|
|
189
|
+
| Aspect | Required (from BRD/Story) | Implemented (from code) | Match |
|
|
190
|
+
|--------|--------------------------|------------------------|-------|
|
|
191
|
+
| Rule | {e.g., required, min:10} | {actual rule found} | MATCH / MISMATCH / MISSING |
|
|
192
|
+
| Error Message | {exact required text} | {exact implemented text} | EXACT / SIMILAR / MISMATCH / MISSING |
|
|
193
|
+
| Trigger | {onChange / onBlur / onSubmit} | {from code} | MATCH / MISMATCH |
|
|
194
|
+
| File | — | {file path} | — |
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
5. `## Validation Message Mismatch Summary` — table of all mismatches:
|
|
198
|
+
| Field | Screen | Required Message | Implemented Message | Severity |
|
|
199
|
+
6. `## Missing Validations` — list of fields that have no validation
|
|
200
|
+
7. `## Extra Validations` — list of validations with no requirement reference
|
|
201
|
+
8. `## Server-Side Validation` — table of API error codes and how they are displayed
|
|
202
|
+
|
|
203
|
+
**Rules**:
|
|
204
|
+
- Required messages must be copied verbatim from BRD/Stories
|
|
205
|
+
- Implemented messages must be resolved from code (not from keys — resolve the actual string)
|
|
206
|
+
- Message comparison is case-sensitive and space-sensitive
|
|
207
|
+
- "SIMILAR" means same intent, different wording (still a mismatch, flag for review)
|
|
208
|
+
|
|
209
|
+
---
|
|
210
|
+
|
|
211
|
+
## File 06 — 06_UI_ANALYSIS.md
|
|
212
|
+
|
|
213
|
+
**Contract**: Screen-by-screen AND component-by-component UI element comparison.
|
|
214
|
+
Components must be audited separately because they contain text labels, placeholder text,
|
|
215
|
+
error messages, and conditional rendering that are prescribed by requirements.
|
|
216
|
+
|
|
217
|
+
**Required Sections**:
|
|
218
|
+
1. `# UI Analysis Report`
|
|
219
|
+
2. `## Summary` — Total required screens | Implemented | Missing | Partial | Coverage %
|
|
220
|
+
3. `## Screen: {ScreenName}` — one section per required screen
|
|
221
|
+
4. `## Component Audit` — one sub-section per relevant shared component
|
|
222
|
+
5. `## Missing Screens` — screens required but not found
|
|
223
|
+
6. `## Extra Screens` — screens found with no requirement reference
|
|
224
|
+
7. `## Conditional UI Analysis` — all conditional rendering across screens AND components
|
|
225
|
+
8. `## Shared Component Compliance` — components that must match required text/behavior
|
|
226
|
+
|
|
227
|
+
**Per-Screen Format**:
|
|
228
|
+
```markdown
|
|
229
|
+
### Screen: {ScreenName}
|
|
230
|
+
**Required by**: {BRD-ID, US-ID}
|
|
231
|
+
**Implemented**: YES | NO | PARTIAL
|
|
232
|
+
**File Path**: {path or "Not found"}
|
|
233
|
+
|
|
234
|
+
#### UI Elements Audit
|
|
235
|
+
| Element | Type | Required | Implemented | Source (Screen or Component) | Status | Evidence |
|
|
236
|
+
|---------|------|----------|-------------|------------------------------|--------|----------|
|
|
237
|
+
|
|
238
|
+
#### Text/Label Audit
|
|
239
|
+
| Element | Required Text | Implemented Text | Source File | Match |
|
|
240
|
+
|---------|---------------|-----------------|-------------|-------|
|
|
241
|
+
|
|
242
|
+
#### States
|
|
243
|
+
| State | Required | Implemented | Evidence |
|
|
244
|
+
|-------|----------|-------------|----------|
|
|
245
|
+
| Loading | | | |
|
|
246
|
+
| Empty | | | |
|
|
247
|
+
| Error | | | |
|
|
248
|
+
| Success | | | |
|
|
249
|
+
|
|
250
|
+
#### Issues
|
|
251
|
+
{bullet list or "None"}
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
**Per-Component Format** (for shared components referenced in screens):
|
|
255
|
+
```markdown
|
|
256
|
+
### Component: {ComponentName}
|
|
257
|
+
**Used by screens**: {list of screens from Component Inventory}
|
|
258
|
+
**Required by**: {BRD-ID, US-ID that prescribe this component's behavior}
|
|
259
|
+
**File Path**: {path}
|
|
260
|
+
|
|
261
|
+
#### Props / Behavior Audit
|
|
262
|
+
| Prop / Behavior | Required | Implemented | Match |
|
|
263
|
+
|-----------------|----------|-------------|-------|
|
|
264
|
+
| Label text | | | |
|
|
265
|
+
| Placeholder text | | | |
|
|
266
|
+
| Error message | | | |
|
|
267
|
+
| Required indicator | | | |
|
|
268
|
+
| Disabled behavior | | | |
|
|
269
|
+
|
|
270
|
+
#### Issues
|
|
271
|
+
{bullet list or "None"}
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
Note on Source column: When a UI element is rendered by a shared component rather than directly
|
|
275
|
+
in the screen file, record the component file path as the evidence source.
|
|
276
|
+
|
|
277
|
+
---
|
|
278
|
+
|
|
279
|
+
## File 07 — 07_API_ANALYSIS.md
|
|
280
|
+
|
|
281
|
+
**Contract**: API-by-API requirement vs implementation comparison.
|
|
282
|
+
|
|
283
|
+
**Required Sections**:
|
|
284
|
+
1. `# API Analysis Report`
|
|
285
|
+
2. `## Summary` — Required APIs | Implemented | Missing | Method Mismatch | Auth Issues
|
|
286
|
+
3. `## API Coverage Matrix` — master table:
|
|
287
|
+
| API | Method | Endpoint | Required By | Implemented | Auth | Error Handling | Status |
|
|
288
|
+
4. `## Missing APIs` — required but not found, with BRD/Story reference
|
|
289
|
+
5. `## Extra APIs` — implemented but not referenced in requirements
|
|
290
|
+
6. `## API Detail — {API name or endpoint}` — one section per API with issues:
|
|
291
|
+
|
|
292
|
+
**Per-API Detail** (only for non-PASS APIs):
|
|
293
|
+
```markdown
|
|
294
|
+
### API: {method} {endpoint}
|
|
295
|
+
**Required by**: {BRD-ID / US-ID}
|
|
296
|
+
**Status**: {status}
|
|
297
|
+
**Implementation File**: {file path}
|
|
298
|
+
|
|
299
|
+
#### Requirement vs Implementation
|
|
300
|
+
| Aspect | Required | Implemented | Match |
|
|
301
|
+
|--------|----------|-------------|-------|
|
|
302
|
+
| Method | | | |
|
|
303
|
+
| Endpoint | | | |
|
|
304
|
+
| Auth Header | | | |
|
|
305
|
+
| Request Payload | | | |
|
|
306
|
+
| Response Mapping | | | |
|
|
307
|
+
| Error Codes Handled | | | |
|
|
308
|
+
| Retry Logic | | | |
|
|
309
|
+
| Timeout | | | |
|
|
310
|
+
|
|
311
|
+
#### Issues
|
|
312
|
+
{specific issues}
|
|
313
|
+
#### Recommendation
|
|
314
|
+
{specific fix}
|
|
315
|
+
```
|
|
316
|
+
|
|
317
|
+
---
|
|
318
|
+
|
|
319
|
+
## File 08 — 08_BUSINESS_LOGIC_ANALYSIS.md
|
|
320
|
+
|
|
321
|
+
**Contract**: Rule-by-rule business logic verification.
|
|
322
|
+
|
|
323
|
+
**Required Sections**:
|
|
324
|
+
1. `# Business Logic Analysis Report`
|
|
325
|
+
2. `## Summary` — Total rules required | Implemented | Partial | Missing | Incorrect
|
|
326
|
+
3. `## Business Rule: {BRD-ID}` — one section per business rule
|
|
327
|
+
|
|
328
|
+
**Per-Rule Format**:
|
|
329
|
+
```markdown
|
|
330
|
+
### Rule: {BRD-ID} — {Rule Name}
|
|
331
|
+
**Type**: Condition | Calculation | Threshold | Eligibility | State Machine | Date Rule
|
|
332
|
+
**Status**: IMPLEMENTED | PARTIALLY_IMPLEMENTED | MISSING | INCORRECT
|
|
333
|
+
|
|
334
|
+
#### Requirement
|
|
335
|
+
{exact text from BRD}
|
|
336
|
+
|
|
337
|
+
#### Implementation Evidence
|
|
338
|
+
- **File**: {path}
|
|
339
|
+
- **Function**: {name}
|
|
340
|
+
- **Code Excerpt**:
|
|
341
|
+
```{language}
|
|
342
|
+
{max 8 lines of relevant code}
|
|
343
|
+
```
|
|
344
|
+
|
|
345
|
+
#### Issues
|
|
346
|
+
{what is wrong or missing, or "None"}
|
|
347
|
+
|
|
348
|
+
#### Recommendation
|
|
349
|
+
{what to fix, or "No action required"}
|
|
350
|
+
```
|
|
351
|
+
|
|
352
|
+
4. `## Calculation Verification` — for every required calculation:
|
|
353
|
+
| Calc | Required Formula | Implemented Formula | Match | Worked Example | Status |
|
|
354
|
+
|
|
355
|
+
**Worked Example column**: Values MUST come from existing test files in the repository, example
|
|
356
|
+
values from BRD/User Story documents, or example values in source code comments. If no source
|
|
357
|
+
example exists, write "No source example found — manual verification required."
|
|
358
|
+
Do NOT invent input values. Fabricated examples create a false impression of verified correctness.
|
|
359
|
+
5. `## Missing Business Rules` — list
|
|
360
|
+
6. `## Extra Business Logic` — list with file references
|
|
361
|
+
|
|
362
|
+
---
|
|
363
|
+
|
|
364
|
+
## File 09 — 09_NAVIGATION_ANALYSIS.md
|
|
365
|
+
|
|
366
|
+
**Contract**: Flow-by-flow navigation audit.
|
|
367
|
+
|
|
368
|
+
**Required Sections**:
|
|
369
|
+
1. `# Navigation Analysis Report`
|
|
370
|
+
2. `## Summary` — Required flows | Implemented | Missing | Incorrect
|
|
371
|
+
3. `## Navigation Flow Matrix` — master table:
|
|
372
|
+
| Flow ID | From Screen | To Screen | Trigger | Parameters | Auth Required | Status |
|
|
373
|
+
4. `## Missing Navigation Flows`
|
|
374
|
+
5. `## Extra Navigation` — flows in code with no requirement reference
|
|
375
|
+
6. `## Deep Link Analysis` (if applicable):
|
|
376
|
+
| Route | Pattern | Implemented | Status |
|
|
377
|
+
7. `## Back Navigation Analysis`:
|
|
378
|
+
| Screen | Back Behavior Required | Implemented | Match |
|
|
379
|
+
8. `## Auth Guard Analysis`:
|
|
380
|
+
| Screen/Flow | Guard Required | Guard Implemented | Match |
|
|
381
|
+
|
|
382
|
+
---
|
|
383
|
+
|
|
384
|
+
## File 10 — 10_TRACEABILITY_MATRIX.md
|
|
385
|
+
|
|
386
|
+
**Contract**: Complete end-to-end requirement traceability.
|
|
387
|
+
|
|
388
|
+
**Required Sections**:
|
|
389
|
+
1. `# Requirements Traceability Matrix`
|
|
390
|
+
2. `## Master Traceability Table`:
|
|
391
|
+
| BRD-ID | BRD Requirement (short) | Story-IDs | AC-IDs | TC-IDs | Implementation Files | Status |
|
|
392
|
+
3. `## Traceability Score` — % of BRD requirements with complete chain
|
|
393
|
+
4. `## Orphan Analysis`:
|
|
394
|
+
- `### BRD Requirements with No User Story` — list with BRD-ID and requirement text
|
|
395
|
+
- `### BRD Requirements with No Test Case` — list
|
|
396
|
+
- `### User Stories with No BRD Reference` — list with US-ID
|
|
397
|
+
- `### Test Cases with No Story Reference` — list with TC-ID
|
|
398
|
+
- `### Test Cases with No BRD Reference` — list
|
|
399
|
+
5. `## Implementation Gap Map` — requirements where implementation file is "None"
|
|
400
|
+
|
|
401
|
+
**Rules**:
|
|
402
|
+
- Every BRD requirement must appear in the master table
|
|
403
|
+
- Story-IDs, AC-IDs, TC-IDs must list ALL related IDs (comma-separated)
|
|
404
|
+
- Implementation Files must list actual file paths (not folder names)
|
|
405
|
+
|
|
406
|
+
---
|
|
407
|
+
|
|
408
|
+
## File 11 — 11_MISSING_FEATURES.md
|
|
409
|
+
|
|
410
|
+
**Contract**: Complete catalog of what was required but not implemented.
|
|
411
|
+
|
|
412
|
+
**Required Sections**:
|
|
413
|
+
1. `# Missing Features Report`
|
|
414
|
+
2. `## Summary` — Total missing items by category
|
|
415
|
+
3. `## Priority 1 — Critical Blockers` (missing items that break core flows)
|
|
416
|
+
4. `## Priority 2 — High Impact` (missing items that break important features)
|
|
417
|
+
5. `## Priority 3 — Medium Impact` (missing items that degrade experience)
|
|
418
|
+
6. `## Priority 4 — Low Impact` (missing items that are cosmetic or minor)
|
|
419
|
+
|
|
420
|
+
**Per Missing Item Format**:
|
|
421
|
+
```markdown
|
|
422
|
+
### MISS-{n} — {Feature Name}
|
|
423
|
+
**Type**: Screen | API | Validation | Business Rule | Navigation | Calculation | UI Element
|
|
424
|
+
**Required by**: {BRD-ID}, {US-ID}, {TC-IDs that will fail}
|
|
425
|
+
**Description**: {what was supposed to be implemented}
|
|
426
|
+
**Impact**: {what breaks without this}
|
|
427
|
+
**Estimated Effort**: High | Medium | Low
|
|
428
|
+
**Dependencies**: {what this feature needs first, or "None"}
|
|
429
|
+
**Recommendation**: {specific implementation guidance}
|
|
430
|
+
```
|
|
431
|
+
|
|
432
|
+
---
|
|
433
|
+
|
|
434
|
+
## File 12 — 12_EXTRA_IMPLEMENTATION.md
|
|
435
|
+
|
|
436
|
+
**Contract**: Catalog of what is implemented but was never requested.
|
|
437
|
+
|
|
438
|
+
**Required Sections**:
|
|
439
|
+
1. `# Extra Implementation Report`
|
|
440
|
+
2. `## Summary` — Total extra items by type
|
|
441
|
+
3. `## Extra Screens`
|
|
442
|
+
4. `## Extra APIs`
|
|
443
|
+
5. `## Extra Business Logic`
|
|
444
|
+
6. `## Extra Validations`
|
|
445
|
+
7. `## Extra Navigation Flows`
|
|
446
|
+
8. `## Dead Code / Unused Components`
|
|
447
|
+
|
|
448
|
+
**Per Item Format**:
|
|
449
|
+
```markdown
|
|
450
|
+
### EXTRA-{n} — {Item Name}
|
|
451
|
+
**Type**: {type}
|
|
452
|
+
**File**: {path}
|
|
453
|
+
**Description**: {what this extra item does}
|
|
454
|
+
**Assessment**: Intentional | Leftover | Speculative
|
|
455
|
+
**Risk**: {potential risk if kept, e.g., security surface, maintenance burden}
|
|
456
|
+
**Recommendation**: Keep | Remove | Document as requirement | Defer
|
|
457
|
+
```
|
|
458
|
+
|
|
459
|
+
**If no extra items found**: state "No extra implementation detected" in each section.
|
|
460
|
+
|
|
461
|
+
---
|
|
462
|
+
|
|
463
|
+
## File 13 — 13_COMPLIANCE_SCORECARD.md
|
|
464
|
+
|
|
465
|
+
**Contract**: Visual, scannable compliance scorecard.
|
|
466
|
+
|
|
467
|
+
**Required Sections**:
|
|
468
|
+
1. `# Compliance Scorecard`
|
|
469
|
+
2. `## Overall Score` — large ASCII visual
|
|
470
|
+
3. `## Dimension Scorecard`:
|
|
471
|
+
```
|
|
472
|
+
| Dimension | Required | Implemented | Missing | Score | Grade |
|
|
473
|
+
|------------------------|----------|-------------|---------|-------|-------|
|
|
474
|
+
| BRD Requirements | | | | XX% | A-F |
|
|
475
|
+
| User Stories | | | | XX% | |
|
|
476
|
+
| Acceptance Criteria | | | | XX% | |
|
|
477
|
+
| Test Cases | | | | XX% | |
|
|
478
|
+
| Validations | | | | XX% | |
|
|
479
|
+
| APIs | | | | XX% | |
|
|
480
|
+
| UI Screens | | | | XX% | |
|
|
481
|
+
| Business Logic | | | | XX% | |
|
|
482
|
+
| Navigation | | | | XX% | |
|
|
483
|
+
```
|
|
484
|
+
4. `## ASCII Bar Charts` — one horizontal bar per dimension (use §Global Bar Chart Format)
|
|
485
|
+
5. `## Benchmark Comparison`:
|
|
486
|
+
| Threshold | Required Score | Actual Score | Result |
|
|
487
|
+
6. `## Grade Scale` — use the grade scale from `assets/coverage-calculation-rules.md` (the
|
|
488
|
+
authoritative source). Do not use a different grade table. Reference the file; do not copy it.
|
|
489
|
+
7. `## Score Calculation` — show the weighted formula with actual numbers. Use weight values from
|
|
490
|
+
`assets/coverage-calculation-rules.md`. If Q9 was set, apply the matching weight preset.
|
|
491
|
+
|
|
492
|
+
---
|
|
493
|
+
|
|
494
|
+
## File 14 — 14_FINAL_RECOMMENDATIONS.md
|
|
495
|
+
|
|
496
|
+
**Contract**: Decision document and action plan. Last file generated.
|
|
497
|
+
|
|
498
|
+
**Required Sections**:
|
|
499
|
+
1. `# Final Recommendations`
|
|
500
|
+
2. `## Audit Decision`
|
|
501
|
+
- Headline: `RECOMMENDED DECISION: SHIP | CONDITIONAL SHIP | DO NOT SHIP`
|
|
502
|
+
- Rationale: 2–4 sentences explaining the decision
|
|
503
|
+
3. `## Prioritized Action Plan`
|
|
504
|
+
|
|
505
|
+
**Action Item Format** (Priority 1 = must fix first):
|
|
506
|
+
```markdown
|
|
507
|
+
### Priority 1 — Blockers (Must Fix Before Any Release)
|
|
508
|
+
| # | Action | Related IDs | Effort | Owner Hint |
|
|
509
|
+
|---|--------|-------------|--------|------------|
|
|
510
|
+
```
|
|
511
|
+
Repeat for Priority 2, 3, 4.
|
|
512
|
+
|
|
513
|
+
4. `## Sprint Plan Suggestion`
|
|
514
|
+
|
|
515
|
+
Sprint groupings use T-shirt size complexity estimates (S/M/L/XL) based on measurable signals
|
|
516
|
+
from the audit — number of missing files, missing validation count, missing API count, and
|
|
517
|
+
business rule complexity. These are complexity groupings, not velocity estimates.
|
|
518
|
+
|
|
519
|
+
| Sprint | Group | Items | Complexity |
|
|
520
|
+
|--------|-------|-------|------------|
|
|
521
|
+
| Sprint 1 | XL items (multi-file blockers, missing core screens, missing APIs) | {list} | XL |
|
|
522
|
+
| Sprint 2 | L items (partially implemented features, validation gaps) | {list} | L |
|
|
523
|
+
| Sprint 3 | M items (message mismatches, minor UI gaps) | {list} | M |
|
|
524
|
+
| Backlog | S items (cosmetic, low-impact, deferred) | {list} | S |
|
|
525
|
+
|
|
526
|
+
Do NOT use story points. Do NOT estimate sprint capacity.
|
|
527
|
+
5. `## Risk Register`
|
|
528
|
+
| # | Risk | Likelihood | Impact | Mitigation |
|
|
529
|
+
6. `## Technical Debt Identified`
|
|
530
|
+
- List of tech debt items found during audit (not requirement gaps, but code quality observations)
|
|
531
|
+
7. `## Process Recommendations`
|
|
532
|
+
- What gaps in the requirements-to-implementation handoff process caused these misses?
|
|
533
|
+
- 3–5 specific process improvements
|
|
534
|
+
8. `## Team Recommendations`
|
|
535
|
+
- Areas needing additional knowledge transfer
|
|
536
|
+
- Areas needing additional QA focus
|
|
537
|
+
9. `## Audit Metadata`
|
|
538
|
+
- Files scanned count
|
|
539
|
+
- Requirements audited count
|
|
540
|
+
- Audit generated by: Claude Code — Project Requirements Compliance Auditor
|
|
541
|
+
|
|
542
|
+
---
|
|
543
|
+
|
|
544
|
+
## Global File Rules
|
|
545
|
+
|
|
546
|
+
1. Every file must begin with a header block:
|
|
547
|
+
```markdown
|
|
548
|
+
# {Title}
|
|
549
|
+
Generated by: Project Requirements Compliance Auditor v3.0.0
|
|
550
|
+
Audit Date: {date}
|
|
551
|
+
Project: {Q4}
|
|
552
|
+
Platform: {Q6}
|
|
553
|
+
```
|
|
554
|
+
2. All tables must have proper column alignment
|
|
555
|
+
3. All code excerpts must use fenced code blocks with language identifier
|
|
556
|
+
4. No file may reference another file's data without that data having been independently computed
|
|
557
|
+
5. Files 14 and 15 must be generated last and may reference data from files 01–13
|
|
558
|
+
|
|
559
|
+
### §Generation Order
|
|
560
|
+
|
|
561
|
+
Generate files in this exact sequence to ensure data dependencies are met:
|
|
562
|
+
|
|
563
|
+
**Phase 1** — Detail files (generate in any order within this phase):
|
|
564
|
+
Files 02, 03, 04, 05, 06, 07, 08, 09, 10, 11
|
|
565
|
+
|
|
566
|
+
**Phase 2** — Extra implementation:
|
|
567
|
+
File 12 (references categories built in Phase 1)
|
|
568
|
+
|
|
569
|
+
**Phase 3** — Scorecard (aggregates Phase 1 + Phase 2 scores):
|
|
570
|
+
File 13
|
|
571
|
+
|
|
572
|
+
**Phase 4** — Executive Summary (derived from scorecard):
|
|
573
|
+
File 01 (MUST be generated AFTER File 13 — it contains the overall score pulled from File 13)
|
|
574
|
+
|
|
575
|
+
**Phase 5** — Recommendations and Security:
|
|
576
|
+
Files 14 and 15 (reference scorecard and detail files)
|
|
577
|
+
|
|
578
|
+
**Rationale**: File 01 requires the weighted overall score, risk level, and dimension summary
|
|
579
|
+
which can only be computed after all detail files are complete. Generating File 01 first produces
|
|
580
|
+
an empty shell with no real numbers.
|
|
581
|
+
|
|
582
|
+
### §Global Bar Chart Format
|
|
583
|
+
|
|
584
|
+
All ASCII bars across ALL output files use this single specification:
|
|
585
|
+
- Width: 40 characters
|
|
586
|
+
- Each `=` represents 2.5%
|
|
587
|
+
- Format: `[{bar}>{ spaces}] {percentage}%`
|
|
588
|
+
- Example (67.5%): `[==========================> ] 67.5%`
|
|
589
|
+
|
|
590
|
+
Do NOT use any other width or scale. This ensures bars are comparable across reports.
|
|
591
|
+
|
|
592
|
+
---
|
|
593
|
+
|
|
594
|
+
## File 15 — 15_SECURITY_ANALYSIS.md
|
|
595
|
+
|
|
596
|
+
**Contract**: Dedicated security compliance audit. Generated in Phase 5 (after File 13).
|
|
597
|
+
|
|
598
|
+
**When to generate**: Always — for all platforms and project types. Security gaps must be reported
|
|
599
|
+
even if no dedicated security requirements exist in the BRD (flag absence of security requirements
|
|
600
|
+
as a finding in §Missing Security Requirements).
|
|
601
|
+
|
|
602
|
+
**Required Sections**:
|
|
603
|
+
1. `# Security Analysis Report`
|
|
604
|
+
2. `## Summary` — Security findings by severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
|
|
605
|
+
3. `## Encryption Compliance`
|
|
606
|
+
- Table: Data Element | Required Encryption (from BRD) | Implemented | Algorithm | Key Management | Status
|
|
607
|
+
- Verify: is encryption applied to data at rest AND in transit as required?
|
|
608
|
+
- Evidence: cite interceptor file, encryption utility, or key derivation module
|
|
609
|
+
|
|
610
|
+
4. `## Authentication & Token Security`
|
|
611
|
+
- Table: Token Type | Storage Location | Expiry | Refresh Logic | Revocation | Status
|
|
612
|
+
- Check: access tokens, refresh tokens, session tokens
|
|
613
|
+
- Verify: tokens not stored in AsyncStorage/localStorage without encryption
|
|
614
|
+
- Verify: token expiry is enforced in code (not just declared in BRD)
|
|
615
|
+
- Verify: refresh logic handles token expiry gracefully
|
|
616
|
+
|
|
617
|
+
5. `## PIN / Password Security`
|
|
618
|
+
- Lockout mechanism: Required (from BRD) | Implemented | Threshold | Lockout duration
|
|
619
|
+
- PIN complexity: Required | Implemented
|
|
620
|
+
- PIN change flow: Required | Implemented
|
|
621
|
+
- Biometric fallback: Required | Implemented
|
|
622
|
+
|
|
623
|
+
6. `## Session Management`
|
|
624
|
+
- Session timeout: Required (from BRD) | Implemented | Evidence
|
|
625
|
+
- Background app lock: Required | Implemented
|
|
626
|
+
- Logout behavior: clears all tokens, local cache, navigation stack
|
|
627
|
+
|
|
628
|
+
7. `## Error Message Safety`
|
|
629
|
+
- Table: Error Scenario | Displayed Message | Contains Sensitive Info | Safe |
|
|
630
|
+
- Flag any error messages that expose stack traces, internal paths, or system details
|
|
631
|
+
|
|
632
|
+
8. `## SSL / Certificate Pinning`
|
|
633
|
+
- Status: Required by BRD | Implemented | Scope (which domains)
|
|
634
|
+
- Evidence: certificate pinning config or network security config file
|
|
635
|
+
|
|
636
|
+
9. `## Sensitive Data Logging`
|
|
637
|
+
- Grep for: console.log, Log.d, print, NSLog, debugPrint near field names like PIN, password, token, OTP
|
|
638
|
+
- Table: File | Line Pattern | Data Exposed | Severity
|
|
639
|
+
|
|
640
|
+
10. `## Missing Security Requirements`
|
|
641
|
+
- List BRD security requirements that have no implementation
|
|
642
|
+
- List security concerns that exist in the implementation but have no BRD requirement coverage
|
|
643
|
+
(e.g., token stored unencrypted but BRD never mentioned encryption — flag as EXTRA RISK)
|
|
644
|
+
|
|
645
|
+
11. `## Security Recommendations` — ordered by severity, most critical first
|
|
646
|
+
|
|
647
|
+
**Rules**:
|
|
648
|
+
- Cite file path and function for every finding
|
|
649
|
+
- Do not mark a security control IMPLEMENTED without reading the implementation
|
|
650
|
+
- "Encryption is used" based on package name alone is MEDIUM confidence — read the actual usage
|
|
651
|
+
- CRITICAL findings in this file should also appear in File 01 §Critical Issues
|