@sallmarta/eye-hate-agent 1.0.2 → 1.0.3

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.
Files changed (89) hide show
  1. package/README.md +38 -310
  2. package/bin/eha.js +203 -118
  3. package/docs/templates/project-docs-template/foundation/architecture.md +79 -0
  4. package/docs/templates/project-docs-template/foundation/changelog.md +53 -0
  5. package/docs/templates/project-docs-template/foundation/feature-inventory.md +46 -0
  6. package/docs/templates/project-docs-template/foundation/phases.md +60 -0
  7. package/docs/templates/project-docs-template/foundation/prd.md +69 -0
  8. package/docs/templates/project-docs-template/foundation/status.md +57 -0
  9. package/docs/templates/project-docs-template/foundation/workflow.md +59 -0
  10. package/docs/templates/project-docs-template/getting-started.md +52 -0
  11. package/docs/{vibes → templates}/project-docs-template/index.md +12 -12
  12. package/docs/templates/project-docs-template/operations/ci-cd.md +56 -0
  13. package/docs/templates/project-docs-template/operations/compliance.md +46 -0
  14. package/docs/templates/project-docs-template/operations/governance.md +46 -0
  15. package/docs/templates/project-docs-template/operations/observability.md +53 -0
  16. package/docs/templates/project-docs-template/operations/production-runbook.md +62 -0
  17. package/docs/templates/project-docs-template/operations/security.md +49 -0
  18. package/docs/templates/project-docs-template/technical/api-contract.md +49 -0
  19. package/docs/templates/project-docs-template/technical/database.md +59 -0
  20. package/docs/templates/project-docs-template/technical/error-handling.md +54 -0
  21. package/docs/templates/project-docs-template/technical/internationalization.md +46 -0
  22. package/docs/templates/project-docs-template/technical/testing.md +57 -0
  23. package/docs/templates/project-docs-template/technical/ui-ux.md +68 -0
  24. package/docs/{vibes → templates}/project-docs-template/technical-guidelines/index.md +3 -3
  25. package/docs/{vibes → templates}/reusable-prompts/00-project-docs-bootstrap.md +2 -4
  26. package/docs/{vibes → templates}/reusable-prompts/00-project-docs-parity.md +3 -5
  27. package/docs/{vibes → templates}/reusable-prompts/00-project-docs-refresh.md +2 -4
  28. package/docs/{vibes → templates}/reusable-prompts/02-sdd-discuss.md +2 -2
  29. package/{.agents/rules/agent.md → docs/templates/rules/agent-rules.md} +6 -11
  30. package/docs/templates/skills/architecture/db-schema-design/SKILL.md +14 -0
  31. package/docs/{vibes/skills → templates/skills/auditing}/full-verification/SKILL.md +1 -1
  32. package/docs/{vibes/skills → templates/skills/auditing}/parity/SKILL.md +2 -2
  33. package/docs/templates/skills/engineering/refactor-specialist/SKILL.md +13 -0
  34. package/docs/{vibes/skills → templates/skills/engineering}/test-authoring/SKILL.md +177 -1
  35. package/docs/templates/skills/engineering/ui-ux-implementation/SKILL.md +13 -0
  36. package/docs/templates/skills/operations/ci-cd-authoring/SKILL.md +13 -0
  37. package/docs/templates/skills/operations/observability-setup/SKILL.md +13 -0
  38. package/package.json +4 -6
  39. package/src/engine/index.js +7 -12
  40. package/src/engine/install.js +67 -163
  41. package/src/engine/runtime-adapters.js +263 -50
  42. package/src/engine/skill-registry.js +67 -0
  43. package/src/engine/state.js +29 -7
  44. package/src/engine/workflow-registry.js +14 -23
  45. package/.claude/commands/eha/README.md +0 -3
  46. package/.claude/commands/eha/eha-bootstrap.md +0 -9
  47. package/.claude/commands/eha/eha-discuss.md +0 -9
  48. package/.claude/commands/eha/eha-execute.md +0 -9
  49. package/.claude/commands/eha/eha-parity.md +0 -9
  50. package/.claude/commands/eha/eha-refresh.md +0 -9
  51. package/.claude/commands/eha/eha-verify.md +0 -9
  52. package/.claude/rules/agent-rules.md +0 -64
  53. package/.github/instructions/agent-rules.instructions.md +0 -63
  54. package/.github/instructions/eha-workflows.instructions.md +0 -21
  55. package/docs/eyehateagent-contract.md +0 -475
  56. package/docs/eyehateagent-maintenance.md +0 -103
  57. package/docs/project-docs/changelog.md +0 -299
  58. package/docs/project-docs/foundation/architecture.md +0 -117
  59. package/docs/project-docs/foundation/status.md +0 -32
  60. package/docs/project-docs/foundation/workflow.md +0 -63
  61. package/docs/project-docs/index.md +0 -20
  62. package/docs/project-docs/testing.md +0 -73
  63. package/docs/vibes/project-docs-template/foundation/architecture.md +0 -79
  64. package/docs/vibes/project-docs-template/foundation/changelog.md +0 -53
  65. package/docs/vibes/project-docs-template/foundation/feature-inventory.md +0 -46
  66. package/docs/vibes/project-docs-template/foundation/phases.md +0 -60
  67. package/docs/vibes/project-docs-template/foundation/prd.md +0 -69
  68. package/docs/vibes/project-docs-template/foundation/status.md +0 -57
  69. package/docs/vibes/project-docs-template/foundation/workflow.md +0 -59
  70. package/docs/vibes/project-docs-template/getting-started.md +0 -52
  71. package/docs/vibes/project-docs-template/operations/ci-cd.md +0 -56
  72. package/docs/vibes/project-docs-template/operations/compliance.md +0 -46
  73. package/docs/vibes/project-docs-template/operations/governance.md +0 -46
  74. package/docs/vibes/project-docs-template/operations/observability.md +0 -53
  75. package/docs/vibes/project-docs-template/operations/production-runbook.md +0 -62
  76. package/docs/vibes/project-docs-template/operations/security.md +0 -49
  77. package/docs/vibes/project-docs-template/technical/api-contract.md +0 -49
  78. package/docs/vibes/project-docs-template/technical/database.md +0 -59
  79. package/docs/vibes/project-docs-template/technical/error-handling.md +0 -54
  80. package/docs/vibes/project-docs-template/technical/internationalization.md +0 -46
  81. package/docs/vibes/project-docs-template/technical/testing.md +0 -57
  82. package/docs/vibes/project-docs-template/technical/ui-ux.md +0 -68
  83. package/docs/vibes/skills/project-elevation/SKILL.md +0 -157
  84. package/docs/vibes/skills/test-authoring/references/patterns.md +0 -116
  85. package/docs/vibes/skills/test-authoring/references/test-types.md +0 -52
  86. /package/docs/{vibes → templates}/reusable-prompts/01-sdd-execute.md +0 -0
  87. /package/docs/{vibes/skills → templates/skills/architecture}/api-design/SKILL.md +0 -0
  88. /package/docs/{vibes/skills/analysis → templates/skills/architecture/system-analysis}/SKILL.md +0 -0
  89. /package/docs/{vibes/skills/code-audit → templates/skills/auditing/security-audit}/SKILL.md +0 -0
@@ -1,46 +0,0 @@
1
- # Governance
2
-
3
- Last update: YYYY-MM-DD
4
-
5
- Status: [Proposed | Draft | Live | Deprecated | Archived]
6
-
7
- ---
8
-
9
- ## 1. Description
10
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Versioning Policy (SemVer)
28
- > [!NOTE] Rules for major, minor, and patch bumps.
29
-
30
- ## 8. Release Cadence
31
- > [!NOTE] Scheduled deploy windows (e.g., every Tuesday).
32
-
33
- ## 9. Code Ownership & Maintainers
34
- > [!NOTE] Who is responsible for which modules.
35
-
36
- ## 10. Contribution Guidelines
37
- > [!NOTE] Rules for external or cross-team PRs.
38
-
39
- ## 11. Success Metrics
40
- > [!NOTE] How we measure if the goals of this document are achieved.
41
-
42
- ## 12. Related Documents
43
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
44
-
45
- ## 13. Open Questions
46
- > [!NOTE] Any unresolved questions or assumptions. Can be empty.
@@ -1,53 +0,0 @@
1
- # Observability & Telemetry
2
-
3
- Last update: YYYY-MM-DD
4
-
5
- Status: [Proposed | Draft | Live | Deprecated | Archived]
6
-
7
- ---
8
-
9
- ## 1. Description
10
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Logging Strategy & Levels
28
- > [!NOTE] Formatting (e.g., JSON) and severity rules (Info/Warn/Error).
29
-
30
- ## 8. Metrics & Dashboards
31
- > [!NOTE] Key Performance Indicators (latency, error rates).
32
-
33
- ## 9. Distributed Tracing
34
- > [!NOTE] Request IDs and flow mapping across microservices.
35
-
36
- ## 10. Alerting Rules & Thresholds
37
- > [!NOTE] Conditions that trigger on-call pages. Flowcharts are preferred. Use mermaid.
38
-
39
- ```mermaid
40
- graph TD
41
- A[Alert Triggered] --> B{Severity Level}
42
- B -- High --> C[Page On-Call]
43
- B -- Low --> D[Log to Ticket]
44
- ```
45
-
46
- ## 11. Success Metrics
47
- > [!NOTE] How we measure if the goals of this document are achieved.
48
-
49
- ## 12. Related Documents
50
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
51
-
52
- ## 13. Open Questions
53
- > [!NOTE] Any unresolved questions or assumptions. Can be empty.
@@ -1,62 +0,0 @@
1
- # Production Runbook
2
-
3
- Last update: YYYY-MM-DD
4
-
5
- Status: [Proposed | Draft | Live | Deprecated | Archived]
6
-
7
- ---
8
-
9
- ## 1. Description
10
- > [!NOTE] Describe what this runbook covers and which environment or service it applies to.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Environment Overview
28
- > [!NOTE] Production environment summary. Key dependencies or infrastructure notes.
29
-
30
- ## 8. Prerequisites and Access
31
- - Required tools
32
- - Required permissions or credentials
33
- - Safety checks before making changes
34
-
35
- ## 9. Release / Deployment Procedure
36
- 1. Step 1
37
- 2. Step 2
38
- 3. Step 3
39
-
40
- ## 10. Verification / Smoke Checks
41
- > [!NOTE] Checks to run to ensure deployment is healthy.
42
-
43
- ## 11. Rollback / Recovery
44
- > [!NOTE] Steps to recover from a failed deployment. Flowcharts are preferred. Use mermaid.
45
-
46
- ```mermaid
47
- graph TD
48
- A[Failure Detected] --> B[Trigger Rollback]
49
- B --> C[Verify Previous State]
50
- ```
51
-
52
- ## 12. Operational Notes
53
- > [!NOTE] Known gotchas.
54
-
55
- ## 13. Success Metrics
56
- > [!NOTE] How we measure if the goals of this document are achieved.
57
-
58
- ## 14. Related Documents
59
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
60
-
61
- ## 15. Open Questions
62
- > [!NOTE] Any unresolved questions or assumptions. Can be empty.
@@ -1,49 +0,0 @@
1
- # Security
2
-
3
- Last update: YYYY-MM-DD
4
-
5
- Status: [Proposed | Draft | Live | Deprecated | Archived]
6
-
7
- ---
8
-
9
- ## 1. Description
10
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Security Objectives
28
- > [!NOTE] Primary assets to protect.
29
-
30
- ## 8. Identified Threats & Vectors
31
- > [!NOTE] Known vulnerabilities (e.g., injection, XSS, DDOS).
32
-
33
- ## 9. Mitigation Strategies
34
- > [!NOTE] How the architecture neutralizes the threats.
35
-
36
- ## 10. Access Control (RBAC)
37
- > [!NOTE] Roles, permissions, and session management.
38
-
39
- ## 11. Data Encryption (At-Rest / In-Transit)
40
- > [!NOTE] Algorithms and key management.
41
-
42
- ## 12. Success Metrics
43
- > [!NOTE] How we measure if the goals of this document are achieved.
44
-
45
- ## 13. Related Documents
46
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
47
-
48
- ## 14. Open Questions
49
- > [!NOTE] Any unresolved questions or assumptions. Can be empty.
@@ -1,49 +0,0 @@
1
- # API Contract
2
-
3
- Last update: YYYY-MM-DD
4
-
5
- Status: [Proposed | Draft | Live | Deprecated | Archived]
6
-
7
- ---
8
-
9
- ## 1. Description
10
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Base URL & Authentication
28
- > [!NOTE] Core connection details and token requirements.
29
-
30
- ## 8. Standard Request/Response Format
31
- > [!NOTE] The expected shape of data (e.g., standard JSON wrapper).
32
-
33
- ## 9. Endpoints (REST / GraphQL)
34
- > [!NOTE] Specific routes, methods, payloads, and responses.
35
-
36
- ## 10. Webhooks & Events
37
- > [!NOTE] Outbound data events pushed to external systems.
38
-
39
- ## 11. Rate Limiting & Constraints
40
- > [!NOTE] Throttling rules and payload size limits.
41
-
42
- ## 12. Success Metrics
43
- > [!NOTE] How we measure if the goals of this document are achieved.
44
-
45
- ## 13. Related Documents
46
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
47
-
48
- ## 14. Open Questions
49
- > [!NOTE] Any unresolved questions or assumptions. Can be empty.
@@ -1,59 +0,0 @@
1
- # Database Schema
2
-
3
- Last update: YYYY-MM-DD
4
-
5
- Status: [Proposed | Draft | Live | Deprecated | Archived]
6
-
7
- ---
8
-
9
- ## 1. Description
10
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Database Architecture
28
- > [!NOTE] Type of DB (SQL/NoSQL) and clustering details.
29
-
30
- ## 8. Entity Relationship Diagram (ERD)
31
- > [!NOTE] Visual or text-based map of table relationships. ERDs are preferred. Use mermaid.
32
-
33
- ```mermaid
34
- erDiagram
35
- CUSTOMER ||--o{ ORDER : places
36
- ORDER ||--|{ LINE-ITEM : contains
37
- CUSTOMER }|..|{ DELIVERY-ADDRESS : uses
38
- ```
39
-
40
- ## 9. Schema Definitions (Tables/Collections)
41
- > [!NOTE] Specific columns, types, and constraints.
42
-
43
- ## 10. Indexes & Performance
44
- > [!NOTE] Keys required for fast lookups.
45
-
46
- ## 11. Migration Strategy
47
- > [!NOTE] How schema changes are versioned and deployed.
48
-
49
- ## 12. Data Dictionary
50
- > [!NOTE] Single source of truth for business definitions. Define what key domain terms actually mean (e.g., "An *Active User* is someone who logged in within 30 days, excluding admins").
51
-
52
- ## 13. Success Metrics
53
- > [!NOTE] How we measure if the goals of this document are achieved.
54
-
55
- ## 14. Related Documents
56
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
57
-
58
- ## 15. Open Questions
59
- > [!NOTE] Any unresolved questions or assumptions. Can be empty.
@@ -1,54 +0,0 @@
1
- # Error Handling
2
-
3
- Last update: YYYY-MM-DD
4
-
5
- Status: [Proposed | Draft | Live | Deprecated | Archived]
6
-
7
- ---
8
-
9
- ## 1. Description
10
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Standard Error Payload
28
- > [!NOTE] The exact JSON shape returned on failure.
29
-
30
- ## 8. Global Error Codes
31
- > [!NOTE] A registry of specific business logic errors.
32
-
33
- ## 9. Client-Side Handling Rules
34
- > [!NOTE] How the frontend should display or retry failures.
35
-
36
- ## 10. Server-Side Fallbacks
37
- > [!NOTE] Circuit breakers and degraded modes. Diagram of fallback flow is preferred. Use mermaid.
38
-
39
- ```mermaid
40
- graph TD
41
- A[Request] --> B{Service Online?}
42
- B -- Yes --> C[Process Request]
43
- B -- No --> D[Trigger Circuit Breaker]
44
- D --> E[Return Fallback Payload]
45
- ```
46
-
47
- ## 11. Success Metrics
48
- > [!NOTE] How we measure if the goals of this document are achieved.
49
-
50
- ## 12. Related Documents
51
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
52
-
53
- ## 13. Open Questions
54
- > [!NOTE] Any unresolved questions or assumptions. Can be empty.
@@ -1,46 +0,0 @@
1
- # Internationalization & Localization
2
-
3
- Last update: YYYY-MM-DD
4
-
5
- Status: [Proposed | Draft | Live | Deprecated | Archived]
6
-
7
- ---
8
-
9
- ## 1. Description
10
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Supported Languages / Locales
28
- > [!NOTE] The explicit list of target regions.
29
-
30
- ## 8. Translation Workflow (TMS)
31
- > [!NOTE] How strings are extracted, translated, and merged.
32
-
33
- ## 9. Fallback Locales
34
- > [!NOTE] The default language when a string is missing.
35
-
36
- ## 10. Date & Currency Formats
37
- > [!NOTE] Regional formatting rules.
38
-
39
- ## 11. Success Metrics
40
- > [!NOTE] How we measure if the goals of this document are achieved.
41
-
42
- ## 12. Related Documents
43
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
44
-
45
- ## 13. Open Questions
46
- > [!NOTE] Any unresolved questions or assumptions. Can be empty.
@@ -1,57 +0,0 @@
1
- # Testing & Verification
2
-
3
- Last update: YYYY-MM-DD
4
-
5
- Status: [Proposed | Draft | Live | Deprecated | Archived]
6
-
7
- ---
8
-
9
- ## 1. Description
10
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Verification Policy & Objectives
28
- > [!NOTE] Define the overarching philosophy for how this repository chooses, runs, and reports testing. What are we trying to prove with our test suite?
29
-
30
- ## 8. Verification Matrix & Coverage
31
- > [!NOTE] The required types of testing (Blackbox, Unit, Security) mapping against expected coverage metrics (e.g., 85% branch coverage).
32
-
33
- | Change type | Preferred validation | Fallback |
34
- | --- | --- | --- |
35
- | Code change | TBD | TBD |
36
- | Documentation change | TBD | TBD |
37
-
38
- ## 9. Test Layers & Environments
39
- > [!NOTE] Detail the exact split of Unit, Component, Integration, and E2E tests. Include the required infrastructure, mocks, and seed data needed to run them.
40
-
41
- ## 10. Commands & CI Gates
42
- > [!NOTE] The exact terminal commands for linting and testing. Outline the required pre-merge CI checks (blocking vs advisory).
43
-
44
- ## 11. Naming & File Conventions
45
- > [!NOTE] Where tests live, how test files are named (e.g., `*.spec.ts`), and how fixtures are stored.
46
-
47
- ## 12. Manual Checks & Fallbacks
48
- > [!NOTE] Necessary manual testing steps and fallback procedures for human verification when automation is impossible.
49
-
50
- ## 13. Success Metrics
51
- > [!NOTE] How we measure if the goals of this document are achieved.
52
-
53
- ## 14. Related Documents
54
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
55
-
56
- ## 15. Open Questions
57
- > [!NOTE] Any unresolved questions or assumptions. Can be empty.
@@ -1,68 +0,0 @@
1
- # UI/UX
2
-
3
- Last update: YYYY-MM-DD
4
-
5
- Status: [Proposed | Draft | Live | Deprecated | Archived]
6
-
7
- ---
8
-
9
- ## 1. Description
10
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Design Philosophy
28
- > [!NOTE] The core principles guiding the user experience.
29
-
30
- ## 8. Design System & Theme
31
- > [!NOTE] Colors, typography, and visual guidelines.
32
-
33
- ## 9. Wireframing & Prototyping
34
- > [!NOTE] Links to external tools (Figma, Adobe) or raw UI specs generated by humans/AI in the repo.
35
-
36
- ## 10. Screen Layouts
37
- > [!NOTE] Core page structures and navigation flows. Wireframes are preferred. Use mermaid.
38
-
39
- ```mermaid
40
- graph TD
41
- A[Home Page] --> B[Dashboard]
42
- A --> C[Profile Settings]
43
- B --> D[Details View]
44
- ```
45
-
46
- ## 11. Component Library
47
- > [!NOTE] Reusable UI elements (buttons, modals).
48
-
49
- ## 12. Responsive Breakpoints
50
- > [!NOTE] Behavior across mobile, tablet, and desktop.
51
-
52
- ## 13. Accessibility (a11y) Requirements
53
- > [!NOTE] Contrast ratios, ARIA labels.
54
-
55
- ## 14. Implementation Backlog
56
- > [!NOTE] List of UI tasks (e.g., `Task-ID: Description`).
57
-
58
- ## 15. Design Handoff Approaches
59
- > [!NOTE] How designs are explicitly transferred to developers.
60
-
61
- ## 16. Success Metrics
62
- > [!NOTE] How we measure if the goals of this document are achieved.
63
-
64
- ## 17. Related Documents
65
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
66
-
67
- ## 18. Open Questions
68
- > [!NOTE] Any unresolved questions or assumptions. Can be empty.