knowzcode 0.3.7 → 0.4.0

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 (79) hide show
  1. package/.claude-plugin/marketplace.json +61 -61
  2. package/.claude-plugin/plugin.json +8 -8
  3. package/LICENSE +121 -121
  4. package/README.md +354 -320
  5. package/agents/analyst.md +114 -114
  6. package/agents/architect.md +200 -200
  7. package/agents/builder.md +104 -104
  8. package/agents/closer.md +177 -177
  9. package/agents/context-scout.md +54 -54
  10. package/agents/knowledge-migrator.md +349 -349
  11. package/agents/knowz-scout.md +83 -83
  12. package/agents/knowz-scribe.md +180 -180
  13. package/agents/microfix-specialist.md +135 -135
  14. package/agents/project-advisor.md +111 -111
  15. package/agents/reviewer.md +172 -172
  16. package/agents/security-officer.md +194 -194
  17. package/agents/test-advisor.md +162 -162
  18. package/agents/update-coordinator.md +394 -394
  19. package/bin/knowzcode.mjs +1199 -956
  20. package/commands/audit.md +328 -328
  21. package/commands/connect-mcp.md +549 -549
  22. package/commands/fix.md +107 -107
  23. package/commands/init.md +500 -439
  24. package/commands/learn.md +332 -332
  25. package/commands/plan.md +272 -272
  26. package/commands/register.md +733 -733
  27. package/commands/status.md +309 -309
  28. package/commands/telemetry-setup.md +368 -368
  29. package/commands/telemetry.md +188 -188
  30. package/commands/work.md +1204 -1202
  31. package/knowzcode/automation_manifest.md +59 -59
  32. package/knowzcode/claude_code_execution.md +431 -420
  33. package/knowzcode/copilot_execution.md +231 -231
  34. package/knowzcode/enterprise/compliance_manifest.md +137 -137
  35. package/knowzcode/enterprise/compliance_status.md +30 -30
  36. package/knowzcode/enterprise/guidelines/code-quality.md +67 -67
  37. package/knowzcode/enterprise/guidelines/security.md +355 -355
  38. package/knowzcode/enterprise/templates/guideline-template.md +55 -55
  39. package/knowzcode/gitignore.template +13 -13
  40. package/knowzcode/knowzcode_architecture.md +51 -51
  41. package/knowzcode/knowzcode_log.md +142 -142
  42. package/knowzcode/knowzcode_loop.md +596 -596
  43. package/knowzcode/knowzcode_orchestration.md +66 -66
  44. package/knowzcode/knowzcode_project.md +48 -48
  45. package/knowzcode/knowzcode_tracker.md +40 -40
  46. package/knowzcode/knowzcode_vaults.md +257 -257
  47. package/knowzcode/mcp_config.md +191 -191
  48. package/knowzcode/planning/Readme.md +6 -6
  49. package/knowzcode/platform_adapters.md +1260 -1047
  50. package/knowzcode/prompts/Execute_Micro_Fix.md +57 -57
  51. package/knowzcode/prompts/Investigate_Codebase.md +227 -227
  52. package/knowzcode/prompts/Migrate_Knowledge.md +301 -301
  53. package/knowzcode/prompts/Refactor_Node.md +72 -72
  54. package/knowzcode/prompts/Spec_Verification_Checkpoint.md +59 -59
  55. package/knowzcode/prompts/[LOOP_1A]__Propose_Change_Set.md +52 -52
  56. package/knowzcode/prompts/[LOOP_1B]__Draft_Specs.md +75 -75
  57. package/knowzcode/prompts/[LOOP_2A]__Implement_Change_Set.md +55 -55
  58. package/knowzcode/prompts/[LOOP_2B]__Verify_Implementation.md +72 -72
  59. package/knowzcode/prompts/[LOOP_3]__Finalize_And_Commit.md +67 -67
  60. package/knowzcode/specs/Readme.md +10 -10
  61. package/knowzcode/telemetry_config.md +89 -89
  62. package/knowzcode/user_preferences.md +120 -120
  63. package/package.json +53 -53
  64. package/skills/alias-resolver.json +1 -1
  65. package/skills/architecture-diff.json +1 -1
  66. package/skills/check-installation-status.json +1 -1
  67. package/skills/continue.md +126 -126
  68. package/skills/environment-guard.json +1 -1
  69. package/skills/generate-workgroup-id.json +1 -1
  70. package/skills/install-knowzcode.json +1 -1
  71. package/skills/load-core-context.json +1 -1
  72. package/skills/log-entry-builder.json +1 -1
  73. package/skills/spec-quality-check.json +1 -1
  74. package/skills/spec-template.json +1 -1
  75. package/skills/spec-validator.json +1 -1
  76. package/skills/start-work.md +224 -224
  77. package/skills/tracker-scan.json +1 -1
  78. package/skills/tracker-update.json +1 -1
  79. package/skills/validate-installation.json +1 -1
@@ -1,55 +1,55 @@
1
- ---
2
- guideline_id: CUSTOM-001
3
- name: "[Guideline Name]"
4
- enforcement: advisory
5
- applies_to: both
6
- priority: medium
7
- ---
8
-
9
- # [Guideline Name]
10
-
11
- **Purpose:** [Brief description of what this guideline ensures]
12
-
13
- > **Instructions:**
14
- > 1. Copy this template to `knowzcode/enterprise/guidelines/` or `guidelines/custom/`
15
- > 2. Fill in sections relevant to your organization
16
- > 3. Add to `compliance_manifest.md` Active Guidelines table
17
- > 4. Set `Active` to `true` in the manifest
18
-
19
- ---
20
-
21
- ## 1. [Category Name]
22
-
23
- ### [ID]: [Requirement Title]
24
-
25
- **Requirement:** [Clear statement of what MUST/SHOULD be done]
26
-
27
- **Applies To:** [spec | implementation | both]
28
-
29
- **Severity:** [critical | high | medium | low]
30
-
31
- **ARC Verification:**
32
- - ARC_[ID]_a: Verify that [specific testable condition]
33
- - ARC_[ID]_b: Verify that [specific testable condition]
34
-
35
- **Compliant Example:**
36
- ```
37
- // Example of code/spec that meets the requirement
38
- ```
39
-
40
- **Non-Compliant Example:**
41
- ```
42
- // VIOLATION: [Explain why this violates the requirement]
43
- ```
44
-
45
- **Remediation:** [Steps to fix violations]
46
-
47
- ---
48
-
49
- ## Compliance Summary
50
-
51
- | ID | Requirement | Severity | Scope |
52
- |:---|:------------|:---------|:------|
53
- | [ID] | [Title] | [severity] | [scope] |
54
-
55
- ---
1
+ ---
2
+ guideline_id: CUSTOM-001
3
+ name: "[Guideline Name]"
4
+ enforcement: advisory
5
+ applies_to: both
6
+ priority: medium
7
+ ---
8
+
9
+ # [Guideline Name]
10
+
11
+ **Purpose:** [Brief description of what this guideline ensures]
12
+
13
+ > **Instructions:**
14
+ > 1. Copy this template to `knowzcode/enterprise/guidelines/` or `guidelines/custom/`
15
+ > 2. Fill in sections relevant to your organization
16
+ > 3. Add to `compliance_manifest.md` Active Guidelines table
17
+ > 4. Set `Active` to `true` in the manifest
18
+
19
+ ---
20
+
21
+ ## 1. [Category Name]
22
+
23
+ ### [ID]: [Requirement Title]
24
+
25
+ **Requirement:** [Clear statement of what MUST/SHOULD be done]
26
+
27
+ **Applies To:** [spec | implementation | both]
28
+
29
+ **Severity:** [critical | high | medium | low]
30
+
31
+ **ARC Verification:**
32
+ - ARC_[ID]_a: Verify that [specific testable condition]
33
+ - ARC_[ID]_b: Verify that [specific testable condition]
34
+
35
+ **Compliant Example:**
36
+ ```
37
+ // Example of code/spec that meets the requirement
38
+ ```
39
+
40
+ **Non-Compliant Example:**
41
+ ```
42
+ // VIOLATION: [Explain why this violates the requirement]
43
+ ```
44
+
45
+ **Remediation:** [Steps to fix violations]
46
+
47
+ ---
48
+
49
+ ## Compliance Summary
50
+
51
+ | ID | Requirement | Severity | Scope |
52
+ |:---|:------------|:---------|:------|
53
+ | [ID] | [Title] | [severity] | [scope] |
54
+
55
+ ---
@@ -1,13 +1,13 @@
1
- # KnowzCode Environment-Specific Files
2
- # These files contain local development environment details
3
- # and should remain purely local to each checkout
4
-
5
- # Environment context (filled during init, unique per dev environment)
6
- environment_context.md
7
-
8
- # Session-specific WorkGroup data
9
- workgroups/
10
-
11
- # Personal notes and scratch files
12
- *.local.md
13
- .scratch/
1
+ # KnowzCode Environment-Specific Files
2
+ # These files contain local development environment details
3
+ # and should remain purely local to each checkout
4
+
5
+ # Environment context (filled during init, unique per dev environment)
6
+ environment_context.md
7
+
8
+ # Session-specific WorkGroup data
9
+ workgroups/
10
+
11
+ # Personal notes and scratch files
12
+ *.local.md
13
+ .scratch/
@@ -1,51 +1,51 @@
1
- # ◆ KnowzCode - Architectural Flowchart
2
-
3
- **Purpose:** This document contains the Mermaid flowchart defining the architecture, components (NodeIDs), and their primary interactions for this project. This visual map is the source of truth for all implementable components tracked in `knowzcode_tracker.md`.
4
-
5
- ---
6
-
7
- ```mermaid
8
- graph TD
9
- %% =================================================================
10
- %% Legend - Defines the shapes and conventions used in this diagram
11
- %% =================================================================
12
- subgraph Legend
13
- direction LR
14
- L_IDConv(NodeID Convention: TYPE_Name)
15
- L_Proc([Process/Backend Logic])
16
- L_UI[/UI Component/]
17
- L_Decision{Decision Point}
18
- L_DB[(Database/Data Store)]
19
- L_ExtAPI{{External API}}
20
- end
21
-
22
- %% =================================================================
23
- %% High-Level Application Flow
24
- %% This is a placeholder. Replace with your project's actual architecture.
25
- %% =================================================================
26
- User((User)) --> UI_LoginPage[/Login Page/]
27
-
28
- subgraph "Authentication Feature"
29
- direction TB
30
- UI_LoginPage -- Credentials --> API_Auth[API: Authenticate User]
31
- API_Auth --> DB_Users[(User Database)]
32
- API_Auth --> Auth_Decision{Is Valid?}
33
- end
34
-
35
- Auth_Decision -- Yes --> UI_Dashboard[/User Dashboard/]
36
- Auth_Decision -- No --> UI_LoginPage
37
-
38
- subgraph "Dashboard Feature"
39
- direction TB
40
- UI_Dashboard -- Request Data --> API_GetData[API: Get User Data]
41
- API_GetData --> SVC_DataAggregator[Service: Aggregate Data]
42
- SVC_DataAggregator --> DB_Products[(Product DB)]
43
- SVC_DataAggregator --> DB_Orders[(Order DB)]
44
- SVC_DataAggregator -- Aggregated Data --> API_GetData
45
- API_GetData -- Formatted Data --> UI_Dashboard
46
- end
47
- ```
48
-
49
- ---
50
-
51
- (This is a template showing a sample application structure. Replace the entire Mermaid content above with the specific flowchart for your project. Use the architecture_generator.md guide for assistance in creating a new flowchart from a project idea.)
1
+ # ◆ KnowzCode - Architectural Flowchart
2
+
3
+ **Purpose:** This document contains the Mermaid flowchart defining the architecture, components (NodeIDs), and their primary interactions for this project. This visual map is the source of truth for all implementable components tracked in `knowzcode_tracker.md`.
4
+
5
+ ---
6
+
7
+ ```mermaid
8
+ graph TD
9
+ %% =================================================================
10
+ %% Legend - Defines the shapes and conventions used in this diagram
11
+ %% =================================================================
12
+ subgraph Legend
13
+ direction LR
14
+ L_IDConv(NodeID Convention: TYPE_Name)
15
+ L_Proc([Process/Backend Logic])
16
+ L_UI[/UI Component/]
17
+ L_Decision{Decision Point}
18
+ L_DB[(Database/Data Store)]
19
+ L_ExtAPI{{External API}}
20
+ end
21
+
22
+ %% =================================================================
23
+ %% High-Level Application Flow
24
+ %% This is a placeholder. Replace with your project's actual architecture.
25
+ %% =================================================================
26
+ User((User)) --> UI_LoginPage[/Login Page/]
27
+
28
+ subgraph "Authentication Feature"
29
+ direction TB
30
+ UI_LoginPage -- Credentials --> API_Auth[API: Authenticate User]
31
+ API_Auth --> DB_Users[(User Database)]
32
+ API_Auth --> Auth_Decision{Is Valid?}
33
+ end
34
+
35
+ Auth_Decision -- Yes --> UI_Dashboard[/User Dashboard/]
36
+ Auth_Decision -- No --> UI_LoginPage
37
+
38
+ subgraph "Dashboard Feature"
39
+ direction TB
40
+ UI_Dashboard -- Request Data --> API_GetData[API: Get User Data]
41
+ API_GetData --> SVC_DataAggregator[Service: Aggregate Data]
42
+ SVC_DataAggregator --> DB_Products[(Product DB)]
43
+ SVC_DataAggregator --> DB_Orders[(Order DB)]
44
+ SVC_DataAggregator -- Aggregated Data --> API_GetData
45
+ API_GetData -- Formatted Data --> UI_Dashboard
46
+ end
47
+ ```
48
+
49
+ ---
50
+
51
+ (This is a template showing a sample application structure. Replace the entire Mermaid content above with the specific flowchart for your project. Use the architecture_generator.md guide for assistance in creating a new flowchart from a project idea.)
@@ -1,142 +1,142 @@
1
- # ◆ KnowzCode - Operational Record
2
-
3
- **Purpose:** This document serves two primary functions for KnowzCode:
4
- 1. **Operational Log**: A chronological, structured record of significant events, decisions, verification outcomes, and artifact changes during the project lifecycle. Maintained by the KnowzCode AI Agent as per `knowzcode_loop.md`.
5
- 2. **Reference Quality Criteria**: A standard list of code quality principles referenced during ARC (Attentive Review & Compliance)-Based Verification.
6
-
7
- ---
8
-
9
- ## Section 1: Operational Log
10
-
11
- **(Instructions for AI Agent: New entries are to be PREPENDED to this section. Use the file modification command specified in your `environment_context.md`. Each entry MUST be separated by `---`, and its `Timestamp` MUST be generated using the timestamp command from your `environment_context.md`.)**
12
- ---
13
- **[NEWEST ENTRIES APPEAR HERE - DO NOT REMOVE THIS MARKER]**
14
- ---
15
- **Type:** SystemInitialization
16
- **Timestamp:** [Generated Timestamp]
17
- **NodeID(s):** Project-Wide
18
- **Logged By:** KnowzCodeSetup
19
- **Details:**
20
- KnowzCode project structure and core files initialized.
21
- - `knowzcode/knowzcode_project.md` (template created)
22
- - `knowzcode/knowzcode_architecture.md` (template created)
23
- - `knowzcode/knowzcode_tracker.md` (template created)
24
- - `knowzcode/knowzcode_loop.md` (created)
25
- - `knowzcode/knowzcode_log.md` (this file - initialized)
26
- - `knowzcode/specs/` directory (created)
27
- ---
28
- **Type:** SpecApproved
29
- **Timestamp:** [Generated Timestamp]
30
- **NodeID(s):** [ExampleNodeID]
31
- **Logged By:** AI-Agent (via Orchestrator)
32
- **Details:**
33
- Specification for `[ExampleNodeID]` has been reviewed and approved by the Orchestrator.
34
- - Key requirements confirmed: [Brief summary or reference to spec version if applicable]
35
- - Agent will now proceed with ARC-Principle-Based Planning for implementation.
36
- ---
37
- **Type:** ◆ ARC-Completion
38
- **Timestamp:** [Generated Timestamp]
39
- **WorkGroupID:** kc-[The ID for this Change Set]
40
- **NodeID(s):** [List ALL NodeIDs in the Change Set]
41
- **Logged By:** KnowzCode AI-Agent
42
- **Details:**
43
- ◆ Successfully implemented and verified the Change Set for [PrimaryGoal].
44
- - **ARC Verification Summary:** All ARC Criteria met for all nodes in the WorkGroupID. [Mention key checks performed].
45
- - **Architectural Learnings:** [Any discoveries about the overall architecture or patterns].
46
- - **Unforeseen Ripple Effects:** [NodeIDs (outside of this WorkGroupID) whose specs may now need review: None | List affected nodes and reason].
47
- - **Specification Finalization:** All specs for the listed NodeIDs updated to "as-built" state.
48
- - **Flowchart Consistency Check Outcome:** [e.g., 'No discrepancies found.', 'Applied simple update: Added link X->Y.', 'Discrepancy noted for Orchestrator review: Node Z interaction requires flowchart restructuring.'].
49
- ---
50
- **Type:** MicroFix
51
- **Timestamp:** [Generated Timestamp]
52
- **NodeID(s)/File:** [TargetNodeID or file_path]
53
- **Logged By:** AI-Agent (via Orchestrator)
54
- **Details:**
55
- - **User Request:** [Orchestrator's brief issue description].
56
- - **Action Taken:** [Brief description of change made].
57
- - **Verification:** [Brief verification method/outcome, e.g., "Confirmed visually", "Ran specific test X"].
58
- ---
59
- **Type:** Decision
60
- **Timestamp:** [Generated Timestamp]
61
- **NodeID(s):** [Relevant NodeID(s) or 'Project-Wide']
62
- **Logged By:** Orchestrator (or AI-Agent if relaying)
63
- **Details:**
64
- [Record of significant decision made, e.g., "User approved deviation X for NodeID Y.", "Tech stack choice for Z confirmed as ABC."].
65
- - Rationale: [Brief reason for the decision, if applicable].
66
- ---
67
- **Type:** Issue
68
- **Timestamp:** [Generated Timestamp]
69
- **NodeID(s):** [Relevant NodeID(s) or 'Project-Wide']
70
- **Logged By:** AI-Agent or Orchestrator
71
- **Details:**
72
- An issue has been identified: [Description of the issue].
73
- - Current Status: [e.g., 'Under Investigation', 'Blocked until X', 'Awaiting user feedback'].
74
- - Proposed Next Steps: [If any].
75
- ---
76
- **Type:** RefactorCompletion
77
- **Timestamp:** [Generated Timestamp]
78
- **WorkGroupID:** [The WorkGroupID for this refactor]
79
- **NodeID(s):** [TargetNodeID]
80
- **Logged By:** AI-Agent
81
- **Details:**
82
- Technical debt resolved via refactoring.
83
- - **Goal:** [Original refactoring goal].
84
- - **Summary of Improvements:** [List of specific improvements made].
85
- - **Verification:** Confirmed that all original ARC Verification Criteria still pass.
86
- ---
87
- **Type:** FeatureAddition
88
- **Timestamp:** [Generated Timestamp]
89
- **NodeID(s):** [List ALL new NodeIDs added]
90
- **Logged By:** AI-Agent
91
- **Details:**
92
- Major new feature added mid-project.
93
- - **Feature Added:** [Name of the new feature].
94
- - **Scope Change:** Project scope expanded from [Old Total] to [New Total] nodes.
95
- - **Architectural Impact:** [Brief description of changes].
96
- - **Implementation Plan:** [Recommended build order for new nodes].
97
- ---
98
- **Type:** IssueUpdate
99
- **Timestamp:** [Generated Timestamp]
100
- **NodeID(s):** [Affected NodeIDs]
101
- **Logged By:** AI-Agent
102
- **Details:**
103
- Critical issue status change.
104
- - **Previous Status:** [e.g., 'Under Investigation'].
105
- - **New Status:** [e.g., 'Resolved', 'Workaround Applied'].
106
- - **Action Taken:** [Brief description of resolution or change].
107
- ---
108
-
109
- **(New log entries will be added above the `[NEWEST ENTRIES APPEAR HERE...]` marker following the `---` separator format.)**
110
-
111
- ---
112
-
113
- ## Section 2: Reference Quality Criteria (ARC-Based Verification)
114
-
115
- **(Instructions for AI Agent: This section is read-only. Refer to these criteria during the "ARC-Based Verification" step (Step 6) and the "ARC-Principle-Based Planning" step (Step 4) as outlined in `knowzcode_loop.md`. Specific project priorities are set in `knowzcode_project.md`.)**
116
-
117
- ### Core Quality Criteria
118
- 1. **Maintainability:** Ease of modification, clarity of code and design, quality of documentation (specs, code comments), low coupling, high cohesion.
119
- 2. **Reliability:** Robustness of error handling, fault tolerance, stability under expected load, data integrity.
120
- 3. **Testability:** Adequacy of unit test coverage (especially for core logic), ease of integration testing, clear separation of concerns enabling testing.
121
- 4. **Performance:** Responsiveness, efficiency in resource utilization (CPU, memory, network) appropriate to project requirements.
122
- 5. **Security:** Resistance to common vulnerabilities (as applicable to project type), secure authentication/authorization, protection of sensitive data, secure handling of inputs.
123
-
124
- ### Structural Criteria
125
- 6. **Readability:** Code clarity, adherence to naming conventions (from `knowzcode_project.md`), consistent formatting, quality and necessity of comments.
126
- 7. **Complexity Management:** Avoidance of overly complex logic (e.g., low cyclomatic/cognitive complexity), manageable size of functions/methods/classes.
127
- 8. **Modularity:** Adherence to Single Responsibility Principle, clear interfaces between components, appropriate use of abstraction.
128
- 9. **Code Duplication (DRY - Don't Repeat Yourself):** Minimization of redundant code through effective use of functions, classes, or modules.
129
- 10. **Standards Compliance:** Adherence to language best practices, project-defined coding standards (from `knowzcode_project.md`), and platform conventions (from `environment_context.md`).
130
-
131
- ### Functional Criteria (Primarily verified via `specs/[NodeID].md` ARC Verification Criteria)
132
- 11. **Completeness:** All specified requirements in `specs/[NodeID].md` are met.
133
- 12. **Correctness:** The implemented functionality behaves as specified in `specs/[NodeID].md` under various conditions.
134
- 13. **Effective Error Handling:** As defined in specs, errors are handled gracefully, appropriate feedback is provided, and the system remains stable.
135
- 14. **Dependency Management:** Correct versions of libraries (from `knowzcode_project.md`) are used; unnecessary dependencies are avoided.
136
-
137
- ### Operational Criteria
138
- 15. **Configuration Management:** Proper use of environment variables for sensitive data; configurations are clear and manageable.
139
- 16. **Resource Usage:** Efficient use of environment resources. Code is written considering the target execution environment.
140
- 17. **API Design (If applicable):** Consistency, usability, and clear contracts for any APIs developed or consumed by the node.
141
-
142
- *(This list guides the ARC-Based Verification process. The ARC Verification Criteria within each `specs/[NodeID].md` file provide specific, testable points derived from these general principles and the node's requirements.)*
1
+ # ◆ KnowzCode - Operational Record
2
+
3
+ **Purpose:** This document serves two primary functions for KnowzCode:
4
+ 1. **Operational Log**: A chronological, structured record of significant events, decisions, verification outcomes, and artifact changes during the project lifecycle. Maintained by the KnowzCode AI Agent as per `knowzcode_loop.md`.
5
+ 2. **Reference Quality Criteria**: A standard list of code quality principles referenced during ARC (Attentive Review & Compliance)-Based Verification.
6
+
7
+ ---
8
+
9
+ ## Section 1: Operational Log
10
+
11
+ **(Instructions for AI Agent: New entries are to be PREPENDED to this section. Use the file modification command specified in your `environment_context.md`. Each entry MUST be separated by `---`, and its `Timestamp` MUST be generated using the timestamp command from your `environment_context.md`.)**
12
+ ---
13
+ **[NEWEST ENTRIES APPEAR HERE - DO NOT REMOVE THIS MARKER]**
14
+ ---
15
+ **Type:** SystemInitialization
16
+ **Timestamp:** [Generated Timestamp]
17
+ **NodeID(s):** Project-Wide
18
+ **Logged By:** KnowzCodeSetup
19
+ **Details:**
20
+ KnowzCode project structure and core files initialized.
21
+ - `knowzcode/knowzcode_project.md` (template created)
22
+ - `knowzcode/knowzcode_architecture.md` (template created)
23
+ - `knowzcode/knowzcode_tracker.md` (template created)
24
+ - `knowzcode/knowzcode_loop.md` (created)
25
+ - `knowzcode/knowzcode_log.md` (this file - initialized)
26
+ - `knowzcode/specs/` directory (created)
27
+ ---
28
+ **Type:** SpecApproved
29
+ **Timestamp:** [Generated Timestamp]
30
+ **NodeID(s):** [ExampleNodeID]
31
+ **Logged By:** AI-Agent (via Orchestrator)
32
+ **Details:**
33
+ Specification for `[ExampleNodeID]` has been reviewed and approved by the Orchestrator.
34
+ - Key requirements confirmed: [Brief summary or reference to spec version if applicable]
35
+ - Agent will now proceed with ARC-Principle-Based Planning for implementation.
36
+ ---
37
+ **Type:** ◆ ARC-Completion
38
+ **Timestamp:** [Generated Timestamp]
39
+ **WorkGroupID:** kc-[The ID for this Change Set]
40
+ **NodeID(s):** [List ALL NodeIDs in the Change Set]
41
+ **Logged By:** KnowzCode AI-Agent
42
+ **Details:**
43
+ ◆ Successfully implemented and verified the Change Set for [PrimaryGoal].
44
+ - **ARC Verification Summary:** All ARC Criteria met for all nodes in the WorkGroupID. [Mention key checks performed].
45
+ - **Architectural Learnings:** [Any discoveries about the overall architecture or patterns].
46
+ - **Unforeseen Ripple Effects:** [NodeIDs (outside of this WorkGroupID) whose specs may now need review: None | List affected nodes and reason].
47
+ - **Specification Finalization:** All specs for the listed NodeIDs updated to "as-built" state.
48
+ - **Flowchart Consistency Check Outcome:** [e.g., 'No discrepancies found.', 'Applied simple update: Added link X->Y.', 'Discrepancy noted for Orchestrator review: Node Z interaction requires flowchart restructuring.'].
49
+ ---
50
+ **Type:** MicroFix
51
+ **Timestamp:** [Generated Timestamp]
52
+ **NodeID(s)/File:** [TargetNodeID or file_path]
53
+ **Logged By:** AI-Agent (via Orchestrator)
54
+ **Details:**
55
+ - **User Request:** [Orchestrator's brief issue description].
56
+ - **Action Taken:** [Brief description of change made].
57
+ - **Verification:** [Brief verification method/outcome, e.g., "Confirmed visually", "Ran specific test X"].
58
+ ---
59
+ **Type:** Decision
60
+ **Timestamp:** [Generated Timestamp]
61
+ **NodeID(s):** [Relevant NodeID(s) or 'Project-Wide']
62
+ **Logged By:** Orchestrator (or AI-Agent if relaying)
63
+ **Details:**
64
+ [Record of significant decision made, e.g., "User approved deviation X for NodeID Y.", "Tech stack choice for Z confirmed as ABC."].
65
+ - Rationale: [Brief reason for the decision, if applicable].
66
+ ---
67
+ **Type:** Issue
68
+ **Timestamp:** [Generated Timestamp]
69
+ **NodeID(s):** [Relevant NodeID(s) or 'Project-Wide']
70
+ **Logged By:** AI-Agent or Orchestrator
71
+ **Details:**
72
+ An issue has been identified: [Description of the issue].
73
+ - Current Status: [e.g., 'Under Investigation', 'Blocked until X', 'Awaiting user feedback'].
74
+ - Proposed Next Steps: [If any].
75
+ ---
76
+ **Type:** RefactorCompletion
77
+ **Timestamp:** [Generated Timestamp]
78
+ **WorkGroupID:** [The WorkGroupID for this refactor]
79
+ **NodeID(s):** [TargetNodeID]
80
+ **Logged By:** AI-Agent
81
+ **Details:**
82
+ Technical debt resolved via refactoring.
83
+ - **Goal:** [Original refactoring goal].
84
+ - **Summary of Improvements:** [List of specific improvements made].
85
+ - **Verification:** Confirmed that all original ARC Verification Criteria still pass.
86
+ ---
87
+ **Type:** FeatureAddition
88
+ **Timestamp:** [Generated Timestamp]
89
+ **NodeID(s):** [List ALL new NodeIDs added]
90
+ **Logged By:** AI-Agent
91
+ **Details:**
92
+ Major new feature added mid-project.
93
+ - **Feature Added:** [Name of the new feature].
94
+ - **Scope Change:** Project scope expanded from [Old Total] to [New Total] nodes.
95
+ - **Architectural Impact:** [Brief description of changes].
96
+ - **Implementation Plan:** [Recommended build order for new nodes].
97
+ ---
98
+ **Type:** IssueUpdate
99
+ **Timestamp:** [Generated Timestamp]
100
+ **NodeID(s):** [Affected NodeIDs]
101
+ **Logged By:** AI-Agent
102
+ **Details:**
103
+ Critical issue status change.
104
+ - **Previous Status:** [e.g., 'Under Investigation'].
105
+ - **New Status:** [e.g., 'Resolved', 'Workaround Applied'].
106
+ - **Action Taken:** [Brief description of resolution or change].
107
+ ---
108
+
109
+ **(New log entries will be added above the `[NEWEST ENTRIES APPEAR HERE...]` marker following the `---` separator format.)**
110
+
111
+ ---
112
+
113
+ ## Section 2: Reference Quality Criteria (ARC-Based Verification)
114
+
115
+ **(Instructions for AI Agent: This section is read-only. Refer to these criteria during the "ARC-Based Verification" step (Step 6) and the "ARC-Principle-Based Planning" step (Step 4) as outlined in `knowzcode_loop.md`. Specific project priorities are set in `knowzcode_project.md`.)**
116
+
117
+ ### Core Quality Criteria
118
+ 1. **Maintainability:** Ease of modification, clarity of code and design, quality of documentation (specs, code comments), low coupling, high cohesion.
119
+ 2. **Reliability:** Robustness of error handling, fault tolerance, stability under expected load, data integrity.
120
+ 3. **Testability:** Adequacy of unit test coverage (especially for core logic), ease of integration testing, clear separation of concerns enabling testing.
121
+ 4. **Performance:** Responsiveness, efficiency in resource utilization (CPU, memory, network) appropriate to project requirements.
122
+ 5. **Security:** Resistance to common vulnerabilities (as applicable to project type), secure authentication/authorization, protection of sensitive data, secure handling of inputs.
123
+
124
+ ### Structural Criteria
125
+ 6. **Readability:** Code clarity, adherence to naming conventions (from `knowzcode_project.md`), consistent formatting, quality and necessity of comments.
126
+ 7. **Complexity Management:** Avoidance of overly complex logic (e.g., low cyclomatic/cognitive complexity), manageable size of functions/methods/classes.
127
+ 8. **Modularity:** Adherence to Single Responsibility Principle, clear interfaces between components, appropriate use of abstraction.
128
+ 9. **Code Duplication (DRY - Don't Repeat Yourself):** Minimization of redundant code through effective use of functions, classes, or modules.
129
+ 10. **Standards Compliance:** Adherence to language best practices, project-defined coding standards (from `knowzcode_project.md`), and platform conventions (from `environment_context.md`).
130
+
131
+ ### Functional Criteria (Primarily verified via `specs/[NodeID].md` ARC Verification Criteria)
132
+ 11. **Completeness:** All specified requirements in `specs/[NodeID].md` are met.
133
+ 12. **Correctness:** The implemented functionality behaves as specified in `specs/[NodeID].md` under various conditions.
134
+ 13. **Effective Error Handling:** As defined in specs, errors are handled gracefully, appropriate feedback is provided, and the system remains stable.
135
+ 14. **Dependency Management:** Correct versions of libraries (from `knowzcode_project.md`) are used; unnecessary dependencies are avoided.
136
+
137
+ ### Operational Criteria
138
+ 15. **Configuration Management:** Proper use of environment variables for sensitive data; configurations are clear and manageable.
139
+ 16. **Resource Usage:** Efficient use of environment resources. Code is written considering the target execution environment.
140
+ 17. **API Design (If applicable):** Consistency, usability, and clear contracts for any APIs developed or consumed by the node.
141
+
142
+ *(This list guides the ARC-Based Verification process. The ARC Verification Criteria within each `specs/[NodeID].md` file provide specific, testable points derived from these general principles and the node's requirements.)*