ai-developer-skill-os 6.0.2 → 7.0.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.
package/.agents/AGENTS.md CHANGED
@@ -28,6 +28,7 @@ If multiple objectives or skills overlap, resolve them in this order:
28
28
  **Rules:**
29
29
  - **MUST** read before write. Always understand context before modifying code.
30
30
  - **MUST NOT** read the whole project unless explicitly required.
31
+ - **ZERO-TRUST CONTEXT:** MUST NOT write business logic until a Dependency Graph or structural map is established (Do not guess the architecture).
31
32
 
32
33
  **Guidelines:**
33
34
  - **Context Budget:** Prefer reading `1 file` → `3 files` → `directory` → `project`.
@@ -55,6 +56,7 @@ If multiple objectives or skills overlap, resolve them in this order:
55
56
  ## 6. Execution & Repair Loop
56
57
  **Rules:**
57
58
  - **Repair Loop:** MUST follow: `Observe` → `Hypothesis` → `Evidence` → `Fix` → `Verify` → `Done`. Do NOT jump directly from Observe to Fix.
59
+ - **Self-Correction (Anti-Slop):** MUST proactively self-audit code (especially UI) against design constraints before emitting. Reject any generic, lazy, or "slop" solutions.
58
60
  - **Escalation Policy:** If 2 consecutive attempts fail (e.g., build fail, permission denied): Stop. Explain the blocker. Request user confirmation before continuing.
59
61
  - **Stopping Criteria:** Stop immediately when: Root cause identified, task completed, required evidence collected, or sufficient confidence reached.
60
62
 
@@ -79,3 +81,9 @@ If multiple objectives or skills overlap, resolve them in this order:
79
81
  - **MUST** use Vietnamese for: User-facing explanations, questions, summaries, progress updates, and the final report.
80
82
  - **MUST NOT** translate: Code snippets, stack traces, file paths, shell commands, config keys, environment variables.
81
83
  - **MUST** follow the required reporting structure (Summary, Changes, Reason, Verification, Risks, Next Action).
84
+
85
+ ## 9. Design Contract (Open Design)
86
+ **Rules:**
87
+ - **MUST** locate and read `DESIGN.md` in the project root before performing any UI or frontend tasks.
88
+ - **MUST NOT** invent design tokens, colors, or typography that contradict `DESIGN.md`.
89
+ - **ENFORCEMENT:** If `DESIGN.md` is missing, the agent MUST request the user to create one (or use bootstrap skill) before continuing UI work.
package/CHANGELOG.md CHANGED
@@ -5,6 +5,17 @@ All notable changes to the **AI Developer Skill OS** project will be documented
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
+ ## [7.0.0] - 2026-07-15
9
+
10
+ ### Changed (The "Anti-Slop & Zero-Trust" Architecture Upgrade)
11
+ - **Zero-Trust Logic**: Core logic skills (`qk-context-loader`, `qk-orchestrator`, `qk-feature-delivery`) now mandate a Topological Context Graph prior to any code generation.
12
+ - **Strict Design Contract**: Frontend skills (`qk-ui-system-builder`, `qk-design-to-code`, `qk-ui-audit`) now explicitly reject generic styling (slop) and enforce strict token matching against a mandated `DESIGN.md`.
13
+ - **Repair Loop Enforcement**: `qk-bug-resolution` updated to strictly prohibit jumping to fixes without explicitly establishing an `Observe -> Hypothesis -> Evidence` chain.
14
+ - **Contract-First APIs**: `qk-api-lifecycle` now requires explicit OpenAPI/Swagger definitions prior to endpoint implementation.
15
+ - **Upgraded Testing Framework**: Fixed regex and validation logic in `behavior-conformance.test.js` to rigorously support YAML array strings and precise V7 markdown constraints. All 22 skills bumped to `v7.0.0`.
16
+ - **Project Bootstrapping**: `qk-project-bootstrap` now scaffolds `DESIGN.md` explicitly upon initialization.
17
+
18
+
8
19
  ## [4.0.0] - 2026-07-02
9
20
 
10
21
  ### Changed (Major Architecture Upgrade)
package/package.json CHANGED
@@ -1,44 +1,44 @@
1
- {
2
- "name": "ai-developer-skill-os",
3
- "version": "6.0.2",
4
- "description": "Behavior Specification Format Framework, AI coding agents (Claude, Cursor, Windsurf, Antigravity) với 23 skills chuyên nghiệp.",
5
- "main": "bin/install.js",
6
- "bin": {
7
- "ai-developer-skill-os": "bin/install.js",
8
- "ai-skill": "bin/install.js"
9
- },
10
- "type": "module",
11
- "scripts": {
12
- "test": "vitest run",
13
- "test:watch": "vitest",
14
- "test:registry": "vitest run --config vitest.config.js",
15
- "lint": "echo \"No linter configured\" && exit 0"
16
- },
17
- "repository": {
18
- "type": "git",
19
- "url": "git+https://github.com/phamquangkhanh2999/ai-developer-skill-os.git"
20
- },
21
- "keywords": [
22
- "ai",
23
- "claude",
24
- "cursor",
25
- "windsurf",
26
- "skills",
27
- "developer",
28
- "agent",
29
- "prompts",
30
- "framework"
31
- ],
32
- "author": "Quang Khánh",
33
- "license": "MIT",
34
- "bugs": {
35
- "url": "https://github.com/phamquangkhanh2999/ai-developer-skill-os/issues"
36
- },
37
- "homepage": "https://github.com/phamquangkhanh2999/ai-developer-skill-os#readme",
38
- "devDependencies": {
39
- "vitest": "^2.1.0",
40
- "fast-glob": "^3.3.0",
41
- "gray-matter": "^4.0.0",
42
- "js-yaml": "^4.1.0"
43
- }
44
- }
1
+ {
2
+ "name": "ai-developer-skill-os",
3
+ "version": "7.0.0",
4
+ "description": "Behavior Specification Format Framework, AI coding agents (Claude, Cursor, Windsurf, Antigravity) với 23 skills chuyên nghiệp.",
5
+ "main": "bin/install.js",
6
+ "bin": {
7
+ "ai-developer-skill-os": "bin/install.js",
8
+ "ai-skill": "bin/install.js"
9
+ },
10
+ "type": "module",
11
+ "scripts": {
12
+ "test": "vitest run",
13
+ "test:watch": "vitest",
14
+ "test:registry": "vitest run --config vitest.config.js",
15
+ "lint": "echo \"No linter configured\" && exit 0"
16
+ },
17
+ "repository": {
18
+ "type": "git",
19
+ "url": "git+https://github.com/phamquangkhanh2999/ai-developer-skill-os.git"
20
+ },
21
+ "keywords": [
22
+ "ai",
23
+ "claude",
24
+ "cursor",
25
+ "windsurf",
26
+ "skills",
27
+ "developer",
28
+ "agent",
29
+ "prompts",
30
+ "framework"
31
+ ],
32
+ "author": "Quang Khánh",
33
+ "license": "MIT",
34
+ "bugs": {
35
+ "url": "https://github.com/phamquangkhanh2999/ai-developer-skill-os/issues"
36
+ },
37
+ "homepage": "https://github.com/phamquangkhanh2999/ai-developer-skill-os#readme",
38
+ "devDependencies": {
39
+ "vitest": "^2.1.0",
40
+ "fast-glob": "^3.3.0",
41
+ "gray-matter": "^4.0.0",
42
+ "js-yaml": "^4.1.0"
43
+ }
44
+ }
@@ -1,35 +1,39 @@
1
1
  ---
2
2
  name: qk-access-policy
3
3
  category: security
4
- version: 6.0.0
4
+ version: 7.0.0
5
+ description: "Quản lý RBAC, ABAC và thiết lập ranh giới bảo mật nghiêm ngặt."
5
6
  ---
6
7
 
7
8
  # qk-access-policy
8
9
 
9
10
  ## Scope
10
- - Security boundaries and policies (Govern)
11
+ - Role-Based and Attribute-Based Access Control configuration (Plan & Execute)
12
+
13
+ ## Verbs
14
+ - `[CONFIGURE]`: Setup explicit role hierarchies and access lists.
11
15
 
12
16
  ## Constraints
13
17
  ```yaml
14
18
  must:
15
- - Enforce access controls at API level
16
- - Check security rules
19
+ - "Explicitly define roles and permissions in a Matrix"
20
+ - "Validate user identity before granting role-based access"
17
21
  must_not:
18
- - Rely on UI-only security
22
+ - "Grant wildcard (*) permissions unless absolutely mandated by system architecture"
23
+ - "Mix authentication logic with authorization logic"
19
24
  ```
20
25
 
21
26
  ## Policies
22
27
  ```yaml
23
28
  prefer:
24
- - Deny-by-default
29
+ - "Attribute-Based Access Control (ABAC) for complex business logic"
25
30
  ```
26
31
 
27
32
  ## Escalation
28
33
  ```yaml
29
34
  stop:
30
- - Policy is missing or ambiguous
35
+ - "Access Matrix is contradictory or undefined"
31
36
  ```
32
37
 
33
38
  ## Output
34
- - Policy enforcement decision
35
- ```
39
+ - RBAC/ABAC configurations and middleware.
@@ -1,37 +1,40 @@
1
1
  ---
2
2
  name: qk-ai-builder
3
- category: ai
4
- version: 6.0.0
3
+ category: core
4
+ version: 7.0.0
5
+ description: "Thiết kế AI Logic, Prompts, RAG pipelines với bảo mật chống Injection."
5
6
  ---
6
7
 
7
8
  # qk-ai-builder
8
9
 
9
10
  ## Scope
10
- - AI logic, prompts, RAG pipelines, and Agents (Plan & Execute)
11
+ - AI integration, Prompt Engineering, and RAG architectures (Plan & Execute)
12
+
13
+ ## Verbs
14
+ - `[PROMPT]`: Design strict and deterministic prompts.
11
15
 
12
16
  ## Constraints
13
17
  ```yaml
14
18
  must:
15
- - Validate prompt changes against actual model outputs
16
- - Handle API rate limits and failures gracefully
19
+ - "Include explicit constraints and negative constraints (must_not) in all prompts"
20
+ - "Sanitize user inputs before feeding them to LLMs (Anti-Injection)"
17
21
  must_not:
18
- - Use LLMs for deterministic logic (e.g. math, exact matching)
19
- - Fabricate non-existent models or APIs
22
+ - "Create open-ended 'chat' prompts without strict system boundaries"
23
+ - "Trust LLM output for critical logic without a validation step"
20
24
  ```
21
25
 
22
26
  ## Policies
23
27
  ```yaml
24
28
  prefer:
25
- - System prompts over user prompts for constraints
26
- - Few-shot examples over complex instructions
29
+ - "Few-shot prompting with clear examples"
30
+ - "Structured output (JSON) over raw text for API interactions"
27
31
  ```
28
32
 
29
33
  ## Escalation
30
34
  ```yaml
31
35
  stop:
32
- - Model context window limits are exceeded
36
+ - "Prompt architecture lacks validation or security boundaries"
33
37
  ```
34
38
 
35
39
  ## Output
36
- - Prompts, pipelines, or Agent configuration
37
- ```
40
+ - Prompts, RAG pipelines, and AI integration logic.
@@ -1,38 +1,46 @@
1
1
  ---
2
2
  name: qk-api-lifecycle
3
3
  category: fullstack
4
- version: 6.0.0
4
+ version: 7.0.0
5
+ description: "Thiết kế, triển khai, và tích hợp các API endpoints với kỷ luật Zero-Trust."
5
6
  ---
6
7
 
7
8
  # qk-api-lifecycle
8
9
 
9
10
  ## Scope
10
11
  - API design, endpoints, contracts, and lifecycle management (Plan & Execute)
12
+ - Zero-Trust validation of API schemas.
13
+
14
+ ## Verbs
15
+ - `[DEFINE]`: Create strict API contracts before implementation.
16
+ - `[IMPLEMENT]`: Build endpoints strictly adhering to the defined contract.
11
17
 
12
18
  ## Constraints
13
19
  ```yaml
14
20
  must:
15
- - Define clear request/response contracts (OpenAPI/Swagger)
16
- - Ensure backward compatibility on existing endpoints
21
+ - "Define clear request/response contracts (OpenAPI/Swagger) BEFORE coding"
22
+ - "Ensure backward compatibility on existing endpoints"
23
+ - "Validate all incoming data against the strict schema"
17
24
  must_not:
18
- - Introduce breaking changes without versioning
19
- - Bypass authentication or authorization checks
25
+ - "Introduce breaking changes without versioning"
26
+ - "Bypass authentication or authorization checks"
27
+ - "Hallucinate or guess external API shapes without evidence"
20
28
  ```
21
29
 
22
30
  ## Policies
23
31
  ```yaml
24
32
  prefer:
25
- - RESTful resource naming conventions
26
- - Meaningful HTTP status codes
33
+ - "RESTful resource naming conventions"
34
+ - "Meaningful HTTP status codes"
35
+ - "Strict type-checking and validation over loose parsing"
27
36
  ```
28
37
 
29
38
  ## Escalation
30
39
  ```yaml
31
40
  stop:
32
- - Required API contracts or models are missing
33
- - Major breaking change detected on production APIs
41
+ - "Required API contracts or models are missing"
42
+ - "Major breaking change detected on production APIs"
34
43
  ```
35
44
 
36
45
  ## Output
37
- - API endpoints, controllers, and documentation
38
- ```
46
+ - API endpoints, controllers, and strict documentation.
@@ -1,39 +1,46 @@
1
1
  ---
2
2
  name: qk-bug-resolution
3
3
  category: maintenance
4
- version: 6.0.0
4
+ version: 7.0.0
5
+ description: "Sửa lỗi (bugs) bằng chu trình khép kín: Quan sát -> Giả thuyết -> Bằng chứng -> Sửa."
5
6
  ---
6
7
 
7
8
  # qk-bug-resolution
8
9
 
9
10
  ## Scope
10
- - Existing defects only (Diagnose)
11
+ - Existing defects only (Diagnose & Repair)
12
+ - Enforcing the strict Repair Loop.
13
+
14
+ ## Verbs
15
+ - `[DIAGNOSE]`: Follow the `Observe -> Hypothesis -> Evidence` loop.
16
+ - `[REPAIR]`: Execute the fix only when confidence is high.
11
17
 
12
18
  ## Constraints
13
19
  ```yaml
14
20
  must:
15
- - Collect evidence (stack trace/logs) before diagnosis
16
- - Verify fix before completion
21
+ - "Strictly follow the Repair Loop: Observe -> Hypothesis -> Evidence -> Fix -> Verify -> Done"
22
+ - "Collect evidence (stack trace/logs/dependency graph) before diagnosis"
23
+ - "Verify fix before completion"
17
24
  must_not:
18
- - Rewrite modules
19
- - Guess root cause without evidence
25
+ - "Jump directly from Observe to Fix (No slop debugging)"
26
+ - "Rewrite modules unnecessarily"
27
+ - "Guess root cause without concrete evidence"
20
28
  ```
21
29
 
22
30
  ## Policies
23
31
  ```yaml
24
32
  prefer:
25
- - Minimal patch
26
- - Regression prevention
33
+ - "Minimal patch"
34
+ - "Root cause resolution over symptom patching"
35
+ - "Regression prevention via targeted tests"
27
36
  ```
28
37
 
29
38
  ## Escalation
30
39
  ```yaml
31
40
  stop:
32
- - Missing logs/evidence
33
- - Fix requires major architectural changes
41
+ - "Missing logs/evidence after 2 attempts to gather them"
42
+ - "Fix requires major architectural changes"
34
43
  ```
35
44
 
36
45
  ## Output
37
- - Minimal patch
38
- - Risk summary
39
- ```
46
+ - Minimal patch and Risk summary.
@@ -1,36 +1,43 @@
1
1
  ---
2
2
  name: qk-context-loader
3
3
  category: utilities
4
- version: 6.0.0
4
+ version: 7.0.0
5
+ description: "Tải các file liên quan và vẽ biểu đồ phụ thuộc (dependency graph) khắt khe trước khi code."
5
6
  ---
6
7
 
7
8
  # qk-context-loader
8
9
 
9
10
  ## Scope
10
- - Context collection and dependency mapping (Collect)
11
+ - Context collection and structural dependency mapping (Collect)
12
+ - Implementing Understand Anything's "Graphing" philosophy to prevent hallucination.
13
+
14
+ ## Verbs
15
+ - `[MAP]`: Analyze file relationships and generate a topological graph or tree map of the domain logic.
11
16
 
12
17
  ## Constraints
13
18
  ```yaml
14
19
  must:
15
- - Find and load related dependency files
20
+ - Generate a Structural Map (Dependency Graph) BEFORE attempting to solve complex tasks.
21
+ - Find and load related dependency files based strictly on the map.
16
22
  must_not:
17
23
  - Modify code
18
24
  - Load entire repo or node_modules
19
- - Hallucinate filenames
25
+ - Guess or hallucinate filenames or API shapes.
26
+ - Skip the graphing phase for business logic tasks.
20
27
  ```
21
28
 
22
29
  ## Policies
23
30
  ```yaml
24
31
  prefer:
25
- - Build dependency graph
32
+ - Deterministic tracing (following imports/exports) over semantic guessing.
26
33
  ```
27
34
 
28
35
  ## Escalation
29
36
  ```yaml
30
37
  stop:
31
38
  - Repo or files are inaccessible
39
+ - Cannot determine the architectural structure (Context overflow)
32
40
  ```
33
41
 
34
42
  ## Output
35
- - Context mapping
36
- ```
43
+ - Explicit JSON or Markdown Topological Graph of Context
@@ -1,35 +1,44 @@
1
1
  ---
2
2
  name: qk-data-lifecycle
3
- category: infrastructure
4
- version: 6.0.0
3
+ category: backend
4
+ version: 7.0.0
5
+ description: "Quản lý Database Schema, Migrations, và Repositories khắt khe với Zero-Trust."
5
6
  ---
6
7
 
7
8
  # qk-data-lifecycle
8
9
 
9
10
  ## Scope
10
- - Database Schema, Migrations, and Repositories management (Plan & Execute)
11
+ - Database Schema management, Migrations, and Repositories (Plan & Execute)
12
+ - Enforcing structural database contracts before implementation.
13
+
14
+ ## Verbs
15
+ - `[SCHEMA]`: Define database tables/models explicitly.
16
+ - `[MIGRATE]`: Safely manage state changes.
11
17
 
12
18
  ## Constraints
13
19
  ```yaml
14
20
  must:
15
- - Ensure data schema matches application domain models
16
- - Generate reversible migration scripts
21
+ - "MUST define explicitly strict database schemas (e.g., Prisma/TypeORM) before writing repository code"
22
+ - "Enforce strict types for all database operations"
17
23
  must_not:
18
- - Perform destructive schema changes without explicit user approval
24
+ - "Create dynamic queries without schema definitions"
25
+ - "Delete or drop columns without a deprecation phase"
26
+ - "Write complex business logic inside repository files"
19
27
  ```
20
28
 
21
29
  ## Policies
22
30
  ```yaml
23
31
  prefer:
24
- - Declarative schema definitions over imperative scripts
32
+ - "Separation of concerns (Repositories handle data, Services handle logic)"
33
+ - "Transactions for multi-table updates"
25
34
  ```
26
35
 
27
36
  ## Escalation
28
37
  ```yaml
29
38
  stop:
30
- - Migration script risks massive data loss
39
+ - "Missing database schema or ORM models"
40
+ - "Attempting destructive migrations on production"
31
41
  ```
32
42
 
33
43
  ## Output
34
- - Database schemas and migration scripts
35
- ```
44
+ - ORM Schema, Repositories, and Migration files.
@@ -1,35 +1,41 @@
1
1
  ---
2
2
  name: qk-db-optimizer
3
- category: infrastructure
4
- version: 6.0.0
3
+ category: backend
4
+ version: 7.0.0
5
+ description: "Tối ưu hóa Database (đánh Index, xử lý N+1 Queries, Slow Queries) dựa trên bằng chứng."
5
6
  ---
6
7
 
7
8
  # qk-db-optimizer
8
9
 
9
10
  ## Scope
10
- - Database optimization (Indexes, N+1 Queries, Slow Queries) (Diagnose & Evaluate)
11
+ - Database Optimization and Performance Auditing (Diagnose & Execute)
12
+
13
+ ## Verbs
14
+ - `[OPTIMIZE]`: Analyze query plans and apply targeted indexes.
11
15
 
12
16
  ## Constraints
13
17
  ```yaml
14
18
  must:
15
- - Analyze query execution plans if available
16
- - Suggest non-breaking performance fixes
19
+ - "Analyze EXPLAIN or Query Plans BEFORE adding indexes"
20
+ - "Solve N+1 queries using Data Loaders or explicit Joins"
21
+ - "Validate query performance improvements"
17
22
  must_not:
18
- - Change database engine or major architecture without consent
23
+ - "Guess missing indexes without slow query logs"
24
+ - "Add overlapping or redundant indexes"
19
25
  ```
20
26
 
21
27
  ## Policies
22
28
  ```yaml
23
29
  prefer:
24
- - Adding indexes before rewriting complex queries
30
+ - "Compound indexes for multi-column queries"
31
+ - "Eager loading over lazy loading for known data relations"
25
32
  ```
26
33
 
27
34
  ## Escalation
28
35
  ```yaml
29
- ask:
30
- - For exact slow query logs if not provided
36
+ stop:
37
+ - "No evidence of slow queries or performance bottlenecks"
31
38
  ```
32
39
 
33
40
  ## Output
34
- - Optimization plan and SQL patches
35
- ```
41
+ - Optimized queries and index migration files.
@@ -1,22 +1,30 @@
1
1
  ---
2
2
  name: qk-design-to-code
3
3
  category: frontend
4
- version: 6.0.0
4
+ version: 7.0.0
5
+ description: "Chuyển đổi thiết kế từ Figma/Images thành các UI component hoàn chỉnh, chuẩn pixel."
5
6
  ---
6
7
 
7
8
  # qk-design-to-code
8
9
 
9
10
  ## Scope
10
11
  - Converting Figma/UI designs into pixel-perfect frontend code (Execute)
12
+ - Rejecting generic templates and enforcing bespoke, high-quality aesthetics.
13
+
14
+ ## Verbs
15
+ - `[REDESIGN]`: Discard generic UI structure, keep data, and rebuild with strict Hallmark/Open Design principles.
16
+ - `[BUILD]`: Generate UI adhering 100% to `DESIGN.md`.
11
17
 
12
18
  ## Constraints
13
19
  ```yaml
14
20
  must:
15
- - Use the project's existing design system / tokens
16
- - Ensure responsive layouts
21
+ - Use the project's existing `DESIGN.md` design system / tokens ONLY
22
+ - Ensure responsive layouts and generous whitespace
23
+ - Include micro-interactions and smooth transitions
17
24
  must_not:
18
25
  - Hardcode magic numbers for spacing/colors
19
26
  - Invent new UI components if existing ones suffice
27
+ - Use generic "AI-slop" aesthetics (e.g., default Tailwind blue/red, cluttered layouts, 1px default borders)
20
28
  ```
21
29
 
22
30
  ## Policies
@@ -24,14 +32,15 @@ must_not:
24
32
  prefer:
25
33
  - Semantic HTML elements
26
34
  - CSS Grid / Flexbox over absolute positioning
35
+ - High-end aesthetics (glassmorphism, organic shadows, exact typography)
27
36
  ```
28
37
 
29
38
  ## Escalation
30
39
  ```yaml
31
40
  stop:
32
- - Design assets or requirements are ambiguous
41
+ - "Design assets or requirements are ambiguous"
42
+ - "DESIGN.md is missing"
33
43
  ```
34
44
 
35
45
  ## Output
36
- - Frontend components and stylesheets
37
- ```
46
+ - Frontend components and stylesheets (Anti-Slop compliant)
@@ -1,36 +1,40 @@
1
1
  ---
2
2
  name: qk-docs
3
- category: utilities
4
- version: 6.0.0
3
+ category: documentation
4
+ version: 7.0.0
5
+ description: "Viết và duy trì tài liệu dự án chính xác tuyệt đối, cấm bịa đặt."
5
6
  ---
6
7
 
7
8
  # qk-docs
8
9
 
9
10
  ## Scope
10
- - Writing and maintaining project documentation for human readability (Execute)
11
+ - Technical documentation, Readme files, and inline comments (Execute)
12
+
13
+ ## Verbs
14
+ - `[DOCUMENT]`: Synchronize documentation with the actual implementation.
11
15
 
12
16
  ## Constraints
13
17
  ```yaml
14
18
  must:
15
- - Keep documentation in sync with the actual codebase
16
- - Use clear, accessible language
19
+ - "Ensure documentation matches the exact implementation in the codebase"
20
+ - "Update documentation whenever corresponding code is changed"
17
21
  must_not:
18
- - Generate overly verbose or redundant docs
19
- - Invent features that don't exist in the code
22
+ - "Hallucinate or guess API parameters not present in the code"
23
+ - "Write generic or useless comments (e.g., '// gets the user')"
20
24
  ```
21
25
 
22
26
  ## Policies
23
27
  ```yaml
24
28
  prefer:
25
- - Examples and code snippets over pure text
29
+ - "Self-documenting code over excessive inline comments"
30
+ - "Living documentation (e.g., Swagger/JSDoc) over isolated Markdown files"
26
31
  ```
27
32
 
28
33
  ## Escalation
29
34
  ```yaml
30
35
  stop:
31
- - The codebase logic is too ambiguous to document accurately
36
+ - "Documentation requests conflict with actual codebase implementation"
32
37
  ```
33
38
 
34
39
  ## Output
35
- - Markdown documentation files
36
- ```
40
+ - Accurate documentation files or inline comments.