incitaciones 0.1.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/LICENSE +395 -0
- package/README.md +410 -0
- package/content/distilled/abstraction-miner.md +32 -0
- package/content/distilled/adversarial-stakeholder-evaluation.md +121 -0
- package/content/distilled/anti-slop-prose.md +46 -0
- package/content/distilled/bias-audit.md +39 -0
- package/content/distilled/code-review/SKILL.md +53 -0
- package/content/distilled/code-review/references/criteria.md +50 -0
- package/content/distilled/code-review/references/templates.md +75 -0
- package/content/distilled/code-review/references/variants.md +32 -0
- package/content/distilled/commit/SKILL.md +41 -0
- package/content/distilled/commit/references/criteria.md +21 -0
- package/content/distilled/commit/references/templates.md +46 -0
- package/content/distilled/composability-diagnostician.md +67 -0
- package/content/distilled/context-guardian.md +20 -0
- package/content/distilled/create-handoff/SKILL.md +16 -0
- package/content/distilled/create-handoff/references/handoff-template.md +65 -0
- package/content/distilled/create-handoff/references/naming.md +7 -0
- package/content/distilled/create-issues/SKILL.md +72 -0
- package/content/distilled/create-issues/references/criteria.md +44 -0
- package/content/distilled/create-issues/references/templates.md +75 -0
- package/content/distilled/create-plan/SKILL.md +19 -0
- package/content/distilled/create-plan/references/plan-template.md +87 -0
- package/content/distilled/create-plan/references/scenarios.md +19 -0
- package/content/distilled/debug/SKILL.md +42 -0
- package/content/distilled/debug/references/criteria.md +27 -0
- package/content/distilled/debug/references/templates.md +39 -0
- package/content/distilled/describe-pr/SKILL.md +17 -0
- package/content/distilled/describe-pr/references/pr-template.md +62 -0
- package/content/distilled/design-practice.md +213 -0
- package/content/distilled/design-review/SKILL.md +29 -0
- package/content/distilled/design-review/references/combined-review.md +27 -0
- package/content/distilled/design-review/references/decision-matrix.md +122 -0
- package/content/distilled/design-review/references/problem-statement.md +141 -0
- package/content/distilled/design-review/references/report-template.md +36 -0
- package/content/distilled/design-review/references/scope-document.md +51 -0
- package/content/distilled/distill-prompt/SKILL.md +41 -0
- package/content/distilled/distill-prompt/references/criteria.md +26 -0
- package/content/distilled/distill-prompt/references/templates.md +30 -0
- package/content/distilled/doc-link-verifier/SKILL.md +212 -0
- package/content/distilled/doc-link-verifier/scripts/check_links.py +453 -0
- package/content/distilled/doc-link-verifier/scripts/extract_links.py +521 -0
- package/content/distilled/edge-case-discovery.md +123 -0
- package/content/distilled/error-handling-diagnostician.md +90 -0
- package/content/distilled/extract-prompt.md +220 -0
- package/content/distilled/formal-verification-evaluator.md +158 -0
- package/content/distilled/grill-me.md +24 -0
- package/content/distilled/guided-review.md +68 -0
- package/content/distilled/implement-documentation.md +68 -0
- package/content/distilled/implement-plan/SKILL.md +23 -0
- package/content/distilled/implement-plan/references/common-situations.md +36 -0
- package/content/distilled/implement-plan/references/verification-template.md +18 -0
- package/content/distilled/invalid-states-diagnostician.md +63 -0
- package/content/distilled/issue-review/SKILL.md +37 -0
- package/content/distilled/issue-review/references/convergence.md +19 -0
- package/content/distilled/issue-review/references/final-report.md +60 -0
- package/content/distilled/issue-review/references/pass-1-clarity.md +28 -0
- package/content/distilled/issue-review/references/pass-2-scope.md +22 -0
- package/content/distilled/issue-review/references/pass-3-dependencies.md +23 -0
- package/content/distilled/issue-review/references/pass-4-alignment.md +17 -0
- package/content/distilled/issue-review/references/pass-5-executability.md +17 -0
- package/content/distilled/issue-review/references/setup.md +25 -0
- package/content/distilled/iterate-plan/SKILL.md +24 -0
- package/content/distilled/iterate-plan/references/change-template.md +15 -0
- package/content/distilled/iterate-plan/references/common-scenarios.md +14 -0
- package/content/distilled/julia-performance-diagnostician.md +71 -0
- package/content/distilled/modularity-diagnostician.md +68 -0
- package/content/distilled/multi-agent-review.md +196 -0
- package/content/distilled/mutability-diagnostician.md +63 -0
- package/content/distilled/narrative-article.md +60 -0
- package/content/distilled/optionality-review.md +190 -0
- package/content/distilled/parallel-review/SKILL.md +49 -0
- package/content/distilled/parallel-review/references/criteria.md +34 -0
- package/content/distilled/parallel-review/references/templates.md +59 -0
- package/content/distilled/plan-review/SKILL.md +42 -0
- package/content/distilled/plan-review/references/criteria.md +51 -0
- package/content/distilled/plan-review/references/templates.md +67 -0
- package/content/distilled/pre-mortem.md +10 -0
- package/content/distilled/project-status-report.md +124 -0
- package/content/distilled/pwa-accessibility-review.md +81 -0
- package/content/distilled/rca-diagnostician/SKILL.md +30 -0
- package/content/distilled/rca-diagnostician/references/action-hierarchy.md +77 -0
- package/content/distilled/rca-diagnostician/references/bias-countermeasures.md +64 -0
- package/content/distilled/rca-diagnostician/references/evidence-timeline.md +49 -0
- package/content/distilled/rca-diagnostician/references/hypothesis-methods.md +53 -0
- package/content/distilled/rca-diagnostician/references/problem-definition.md +34 -0
- package/content/distilled/rca-diagnostician/references/report-template.md +75 -0
- package/content/distilled/rca-diagnostician/references/rigor-checklist.md +66 -0
- package/content/distilled/red-team-review.md +133 -0
- package/content/distilled/research-codebase/SKILL.md +22 -0
- package/content/distilled/research-codebase/references/report-template.md +75 -0
- package/content/distilled/research-codebase/references/search-patterns.md +27 -0
- package/content/distilled/research-documentation.md +79 -0
- package/content/distilled/research-review/SKILL.md +42 -0
- package/content/distilled/research-review/references/criteria.md +51 -0
- package/content/distilled/research-review/references/templates.md +73 -0
- package/content/distilled/resonant-refactor.md +45 -0
- package/content/distilled/resume-handoff/SKILL.md +19 -0
- package/content/distilled/resume-handoff/references/analysis-template.md +40 -0
- package/content/distilled/resume-handoff/references/locating.md +12 -0
- package/content/distilled/review-documentation.md +44 -0
- package/content/distilled/rigidity-diagnostician.md +70 -0
- package/content/distilled/rule-of-5-universal/SKILL.md +26 -0
- package/content/distilled/rule-of-5-universal/references/criteria.md +34 -0
- package/content/distilled/rule-of-5-universal/references/examples.md +69 -0
- package/content/distilled/rule-of-5-universal/references/templates.md +136 -0
- package/content/distilled/specification-evaluation-diagnostician.md +106 -0
- package/content/distilled/specification-review/SKILL.md +43 -0
- package/content/distilled/specification-review/references/criteria.md +51 -0
- package/content/distilled/specification-review/references/templates.md +67 -0
- package/content/distilled/systematic-housekeeping.md +27 -0
- package/content/distilled/tdd/SKILL.md +38 -0
- package/content/distilled/tdd/references/criteria.md +26 -0
- package/content/distilled/tdd/references/templates.md +53 -0
- package/content/distilled/test-abstraction-miner.md +43 -0
- package/content/distilled/test-friction.md +51 -0
- package/content/distilled/testability-implementability-evaluator.md +144 -0
- package/content/distilled/ui-align.md +32 -0
- package/content/distilled/ux-dx-evaluation-diagnostician/SKILL.md +21 -0
- package/content/distilled/ux-dx-evaluation-diagnostician/references/layer-1-product.md +20 -0
- package/content/distilled/ux-dx-evaluation-diagnostician/references/layer-2-engineering.md +20 -0
- package/content/distilled/ux-dx-evaluation-diagnostician/references/layer-3-interface.md +23 -0
- package/content/distilled/ux-dx-evaluation-diagnostician/references/layer-4-ecosystem.md +20 -0
- package/content/distilled/ux-dx-evaluation-diagnostician/references/layer-5-documentation.md +19 -0
- package/content/distilled/ux-dx-evaluation-diagnostician/references/report-template.md +36 -0
- package/content/distilled/verification-diagnostician.md +90 -0
- package/content/distilled/verify-prompt/SKILL.md +32 -0
- package/content/distilled/verify-prompt/references/criteria.md +21 -0
- package/content/manifest.json +3220 -0
- package/package.json +50 -0
- package/pi-package/README.md +9 -0
- package/pi-package/prompts/abstraction-miner.md +10 -0
- package/pi-package/prompts/adversarial-stakeholder-evaluation.md +10 -0
- package/pi-package/prompts/anti-slop-prose.md +10 -0
- package/pi-package/prompts/bias-audit.md +10 -0
- package/pi-package/prompts/code-review.md +10 -0
- package/pi-package/prompts/commit.md +10 -0
- package/pi-package/prompts/composability-diagnostician.md +10 -0
- package/pi-package/prompts/context-guardian.md +10 -0
- package/pi-package/prompts/create-handoff.md +10 -0
- package/pi-package/prompts/create-issues.md +10 -0
- package/pi-package/prompts/create-plan.md +10 -0
- package/pi-package/prompts/debug.md +10 -0
- package/pi-package/prompts/describe-pr.md +10 -0
- package/pi-package/prompts/design-practice.md +10 -0
- package/pi-package/prompts/design-review.md +10 -0
- package/pi-package/prompts/distill-prompt.md +10 -0
- package/pi-package/prompts/doc-link-verifier.md +10 -0
- package/pi-package/prompts/edge-case-discovery.md +10 -0
- package/pi-package/prompts/error-handling-diagnostician.md +10 -0
- package/pi-package/prompts/extract-prompt.md +10 -0
- package/pi-package/prompts/formal-verification-evaluator.md +10 -0
- package/pi-package/prompts/grill-me.md +10 -0
- package/pi-package/prompts/guided-review.md +10 -0
- package/pi-package/prompts/implement-documentation.md +10 -0
- package/pi-package/prompts/implement-plan.md +10 -0
- package/pi-package/prompts/invalid-states-diagnostician.md +10 -0
- package/pi-package/prompts/issue-review.md +10 -0
- package/pi-package/prompts/iterate-plan.md +10 -0
- package/pi-package/prompts/julia-performance-diagnostician.md +10 -0
- package/pi-package/prompts/modularity-diagnostician.md +10 -0
- package/pi-package/prompts/multi-agent-review.md +10 -0
- package/pi-package/prompts/mutability-diagnostician.md +10 -0
- package/pi-package/prompts/narrative-article.md +10 -0
- package/pi-package/prompts/optionality-review.md +10 -0
- package/pi-package/prompts/parallel-review.md +10 -0
- package/pi-package/prompts/plan-review.md +10 -0
- package/pi-package/prompts/pre-mortem.md +10 -0
- package/pi-package/prompts/project-status-report.md +10 -0
- package/pi-package/prompts/pwa-accessibility-review.md +10 -0
- package/pi-package/prompts/rca-diagnostician.md +10 -0
- package/pi-package/prompts/red-team-review.md +10 -0
- package/pi-package/prompts/research-codebase.md +10 -0
- package/pi-package/prompts/research-documentation.md +10 -0
- package/pi-package/prompts/research-review.md +10 -0
- package/pi-package/prompts/resonant-refactor.md +10 -0
- package/pi-package/prompts/resume-handoff.md +10 -0
- package/pi-package/prompts/review-documentation.md +10 -0
- package/pi-package/prompts/rigidity-diagnostician.md +10 -0
- package/pi-package/prompts/rule-of-5-universal.md +10 -0
- package/pi-package/prompts/specification-evaluation-diagnostician.md +10 -0
- package/pi-package/prompts/specification-review.md +10 -0
- package/pi-package/prompts/systematic-housekeeping.md +10 -0
- package/pi-package/prompts/tdd.md +10 -0
- package/pi-package/prompts/test-abstraction-miner.md +10 -0
- package/pi-package/prompts/test-friction.md +10 -0
- package/pi-package/prompts/testability-implementability-evaluator.md +10 -0
- package/pi-package/prompts/ui-align.md +10 -0
- package/pi-package/prompts/ux-dx-evaluation-diagnostician.md +10 -0
- package/pi-package/prompts/verification-diagnostician.md +10 -0
- package/pi-package/prompts/verify-prompt.md +10 -0
- package/pi-package/skills/abstraction-miner/SKILL.md +38 -0
- package/pi-package/skills/adversarial-stakeholder-evaluation/SKILL.md +127 -0
- package/pi-package/skills/anti-slop-prose/SKILL.md +52 -0
- package/pi-package/skills/bias-audit/SKILL.md +45 -0
- package/pi-package/skills/code-review/SKILL.md +59 -0
- package/pi-package/skills/code-review/references/criteria.md +50 -0
- package/pi-package/skills/code-review/references/templates.md +75 -0
- package/pi-package/skills/code-review/references/variants.md +32 -0
- package/pi-package/skills/commit/SKILL.md +47 -0
- package/pi-package/skills/commit/references/criteria.md +21 -0
- package/pi-package/skills/commit/references/templates.md +46 -0
- package/pi-package/skills/composability-diagnostician/SKILL.md +73 -0
- package/pi-package/skills/context-guardian/SKILL.md +26 -0
- package/pi-package/skills/create-handoff/SKILL.md +22 -0
- package/pi-package/skills/create-handoff/references/handoff-template.md +65 -0
- package/pi-package/skills/create-handoff/references/naming.md +7 -0
- package/pi-package/skills/create-issues/SKILL.md +78 -0
- package/pi-package/skills/create-issues/references/criteria.md +44 -0
- package/pi-package/skills/create-issues/references/templates.md +75 -0
- package/pi-package/skills/create-plan/SKILL.md +25 -0
- package/pi-package/skills/create-plan/references/plan-template.md +87 -0
- package/pi-package/skills/create-plan/references/scenarios.md +19 -0
- package/pi-package/skills/debug/SKILL.md +48 -0
- package/pi-package/skills/debug/references/criteria.md +27 -0
- package/pi-package/skills/debug/references/templates.md +39 -0
- package/pi-package/skills/describe-pr/SKILL.md +23 -0
- package/pi-package/skills/describe-pr/references/pr-template.md +62 -0
- package/pi-package/skills/design-practice/SKILL.md +219 -0
- package/pi-package/skills/design-review/SKILL.md +35 -0
- package/pi-package/skills/design-review/references/combined-review.md +27 -0
- package/pi-package/skills/design-review/references/decision-matrix.md +122 -0
- package/pi-package/skills/design-review/references/problem-statement.md +141 -0
- package/pi-package/skills/design-review/references/report-template.md +36 -0
- package/pi-package/skills/design-review/references/scope-document.md +51 -0
- package/pi-package/skills/distill-prompt/SKILL.md +47 -0
- package/pi-package/skills/distill-prompt/references/criteria.md +26 -0
- package/pi-package/skills/distill-prompt/references/templates.md +30 -0
- package/pi-package/skills/doc-link-verifier/SKILL.md +218 -0
- package/pi-package/skills/doc-link-verifier/scripts/check_links.py +453 -0
- package/pi-package/skills/doc-link-verifier/scripts/extract_links.py +521 -0
- package/pi-package/skills/edge-case-discovery/SKILL.md +129 -0
- package/pi-package/skills/error-handling-diagnostician/SKILL.md +96 -0
- package/pi-package/skills/extract-prompt/SKILL.md +226 -0
- package/pi-package/skills/formal-verification-evaluator/SKILL.md +164 -0
- package/pi-package/skills/grill-me/SKILL.md +30 -0
- package/pi-package/skills/guided-review/SKILL.md +74 -0
- package/pi-package/skills/implement-documentation/SKILL.md +74 -0
- package/pi-package/skills/implement-plan/SKILL.md +29 -0
- package/pi-package/skills/implement-plan/references/common-situations.md +36 -0
- package/pi-package/skills/implement-plan/references/verification-template.md +18 -0
- package/pi-package/skills/invalid-states-diagnostician/SKILL.md +69 -0
- package/pi-package/skills/issue-review/SKILL.md +43 -0
- package/pi-package/skills/issue-review/references/convergence.md +19 -0
- package/pi-package/skills/issue-review/references/final-report.md +60 -0
- package/pi-package/skills/issue-review/references/pass-1-clarity.md +28 -0
- package/pi-package/skills/issue-review/references/pass-2-scope.md +22 -0
- package/pi-package/skills/issue-review/references/pass-3-dependencies.md +23 -0
- package/pi-package/skills/issue-review/references/pass-4-alignment.md +17 -0
- package/pi-package/skills/issue-review/references/pass-5-executability.md +17 -0
- package/pi-package/skills/issue-review/references/setup.md +25 -0
- package/pi-package/skills/iterate-plan/SKILL.md +30 -0
- package/pi-package/skills/iterate-plan/references/change-template.md +15 -0
- package/pi-package/skills/iterate-plan/references/common-scenarios.md +14 -0
- package/pi-package/skills/julia-performance-diagnostician/SKILL.md +77 -0
- package/pi-package/skills/modularity-diagnostician/SKILL.md +74 -0
- package/pi-package/skills/multi-agent-review/SKILL.md +202 -0
- package/pi-package/skills/mutability-diagnostician/SKILL.md +69 -0
- package/pi-package/skills/narrative-article/SKILL.md +66 -0
- package/pi-package/skills/optionality-review/SKILL.md +196 -0
- package/pi-package/skills/parallel-review/SKILL.md +55 -0
- package/pi-package/skills/parallel-review/references/criteria.md +34 -0
- package/pi-package/skills/parallel-review/references/templates.md +59 -0
- package/pi-package/skills/plan-review/SKILL.md +48 -0
- package/pi-package/skills/plan-review/references/criteria.md +51 -0
- package/pi-package/skills/plan-review/references/templates.md +67 -0
- package/pi-package/skills/pre-mortem/SKILL.md +16 -0
- package/pi-package/skills/project-status-report/SKILL.md +130 -0
- package/pi-package/skills/pwa-accessibility-review/SKILL.md +87 -0
- package/pi-package/skills/rca-diagnostician/SKILL.md +36 -0
- package/pi-package/skills/rca-diagnostician/references/action-hierarchy.md +77 -0
- package/pi-package/skills/rca-diagnostician/references/bias-countermeasures.md +64 -0
- package/pi-package/skills/rca-diagnostician/references/evidence-timeline.md +49 -0
- package/pi-package/skills/rca-diagnostician/references/hypothesis-methods.md +53 -0
- package/pi-package/skills/rca-diagnostician/references/problem-definition.md +34 -0
- package/pi-package/skills/rca-diagnostician/references/report-template.md +75 -0
- package/pi-package/skills/rca-diagnostician/references/rigor-checklist.md +66 -0
- package/pi-package/skills/red-team-review/SKILL.md +139 -0
- package/pi-package/skills/research-codebase/SKILL.md +28 -0
- package/pi-package/skills/research-codebase/references/report-template.md +75 -0
- package/pi-package/skills/research-codebase/references/search-patterns.md +27 -0
- package/pi-package/skills/research-documentation/SKILL.md +85 -0
- package/pi-package/skills/research-review/SKILL.md +48 -0
- package/pi-package/skills/research-review/references/criteria.md +51 -0
- package/pi-package/skills/research-review/references/templates.md +73 -0
- package/pi-package/skills/resonant-refactor/SKILL.md +51 -0
- package/pi-package/skills/resume-handoff/SKILL.md +25 -0
- package/pi-package/skills/resume-handoff/references/analysis-template.md +40 -0
- package/pi-package/skills/resume-handoff/references/locating.md +12 -0
- package/pi-package/skills/review-documentation/SKILL.md +50 -0
- package/pi-package/skills/rigidity-diagnostician/SKILL.md +76 -0
- package/pi-package/skills/rule-of-5-universal/SKILL.md +32 -0
- package/pi-package/skills/rule-of-5-universal/references/criteria.md +34 -0
- package/pi-package/skills/rule-of-5-universal/references/examples.md +69 -0
- package/pi-package/skills/rule-of-5-universal/references/templates.md +136 -0
- package/pi-package/skills/specification-evaluation-diagnostician/SKILL.md +112 -0
- package/pi-package/skills/specification-review/SKILL.md +49 -0
- package/pi-package/skills/specification-review/references/criteria.md +51 -0
- package/pi-package/skills/specification-review/references/templates.md +67 -0
- package/pi-package/skills/systematic-housekeeping/SKILL.md +33 -0
- package/pi-package/skills/tdd/SKILL.md +44 -0
- package/pi-package/skills/tdd/references/criteria.md +26 -0
- package/pi-package/skills/tdd/references/templates.md +53 -0
- package/pi-package/skills/test-abstraction-miner/SKILL.md +49 -0
- package/pi-package/skills/test-friction/SKILL.md +57 -0
- package/pi-package/skills/testability-implementability-evaluator/SKILL.md +150 -0
- package/pi-package/skills/ui-align/SKILL.md +38 -0
- package/pi-package/skills/ux-dx-evaluation-diagnostician/SKILL.md +27 -0
- package/pi-package/skills/ux-dx-evaluation-diagnostician/references/layer-1-product.md +20 -0
- package/pi-package/skills/ux-dx-evaluation-diagnostician/references/layer-2-engineering.md +20 -0
- package/pi-package/skills/ux-dx-evaluation-diagnostician/references/layer-3-interface.md +23 -0
- package/pi-package/skills/ux-dx-evaluation-diagnostician/references/layer-4-ecosystem.md +20 -0
- package/pi-package/skills/ux-dx-evaluation-diagnostician/references/layer-5-documentation.md +19 -0
- package/pi-package/skills/ux-dx-evaluation-diagnostician/references/report-template.md +36 -0
- package/pi-package/skills/verification-diagnostician/SKILL.md +96 -0
- package/pi-package/skills/verify-prompt/SKILL.md +38 -0
- package/pi-package/skills/verify-prompt/references/criteria.md +21 -0
- package/scripts/cli.mjs +453 -0
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Research Review Criteria
|
|
2
|
+
|
|
3
|
+
Use these criteria to categorize findings and determine when the review process is complete.
|
|
4
|
+
|
|
5
|
+
## Issue Severity Definitions
|
|
6
|
+
|
|
7
|
+
| Severity | Criteria | Example Findings |
|
|
8
|
+
| :--- | :--- | :--- |
|
|
9
|
+
| **CRITICAL** | Factually wrong or misleading. Claims made about the codebase or external APIs that are false. | Incorrect architectural claim, broken code example, citation that doesn't support the claim. |
|
|
10
|
+
| **HIGH** | Significant gaps in analysis or logic. Conclusions that do not follow from findings. | Unanswered research question, missing trade-off analysis, no actionable recommendation. |
|
|
11
|
+
| **MEDIUM** | Could be clearer, more complete, or more organized. | Vague terminology, inconsistent formatting, redundant sections, minor depth gaps. |
|
|
12
|
+
| **LOW** | Minor improvements or metadata gaps. | Typos, outdated minor library versions, missing cross-references. |
|
|
13
|
+
|
|
14
|
+
## Convergence Criteria
|
|
15
|
+
|
|
16
|
+
**CONVERGED** if:
|
|
17
|
+
- No new **CRITICAL** issues were found in the current pass AND
|
|
18
|
+
- The number of new issues found is less than 10% compared to the previous pass AND
|
|
19
|
+
- The estimated false positive rate is below 20%.
|
|
20
|
+
|
|
21
|
+
**NEEDS_HUMAN** if:
|
|
22
|
+
- After 5 passes, new **CRITICAL** issues are still being discovered.
|
|
23
|
+
- The false positive rate exceeds 30%.
|
|
24
|
+
- A fundamental disagreement on methodology or problem framing is identified.
|
|
25
|
+
|
|
26
|
+
## Pass Focus Checklist
|
|
27
|
+
|
|
28
|
+
### Pass 1: Accuracy & Sources
|
|
29
|
+
- [ ] Are all claims backed by code references or citations?
|
|
30
|
+
- [ ] Are the cited sources credible and recent?
|
|
31
|
+
- [ ] Are technical details factually correct?
|
|
32
|
+
|
|
33
|
+
### Pass 2: Completeness & Scope
|
|
34
|
+
- [ ] Are all initial research questions answered?
|
|
35
|
+
- [ ] Are there obvious related topics that were ignored?
|
|
36
|
+
- [ ] Is the depth of analysis appropriate for the subject?
|
|
37
|
+
|
|
38
|
+
### Pass 3: Clarity & Structure
|
|
39
|
+
- [ ] Does the document flow logically from findings to conclusions?
|
|
40
|
+
- [ ] Are all technical terms and jargon defined?
|
|
41
|
+
- [ ] Is the terminology consistent throughout?
|
|
42
|
+
|
|
43
|
+
### Pass 4: Actionability & Conclusions
|
|
44
|
+
- [ ] Are the takeaways and recommendations clear?
|
|
45
|
+
- [ ] Are the trade-offs of proposed solutions articulated?
|
|
46
|
+
- [ ] Is there implementable guidance for the next steps?
|
|
47
|
+
|
|
48
|
+
### Pass 5: Integration & Context
|
|
49
|
+
- [ ] Does this research contradict established project decisions?
|
|
50
|
+
- [ ] Are there connections to related specs and codebase patterns?
|
|
51
|
+
- [ ] Does it provide clear guidance for decision-making?
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# Research Review Templates
|
|
2
|
+
|
|
3
|
+
Use these templates to provide a structured, high-signal report for each pass and the final verdict.
|
|
4
|
+
|
|
5
|
+
## Pass Output Template
|
|
6
|
+
|
|
7
|
+
Use this format for reporting results from any of the five passes.
|
|
8
|
+
|
|
9
|
+
```markdown
|
|
10
|
+
### PASS [N]: [Focus Area]
|
|
11
|
+
|
|
12
|
+
#### Issues Found:
|
|
13
|
+
[ID] [CRITICAL|HIGH|MEDIUM|LOW] - [Section/Paragraph]
|
|
14
|
+
**Description:** [What's inaccurate, incomplete, or ambiguous]
|
|
15
|
+
**Evidence:** [Why this is a problem - cite source or codebase]
|
|
16
|
+
**Recommendation:** [How to improve with specific research or fix]
|
|
17
|
+
|
|
18
|
+
[ID] ...
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Convergence Check Template
|
|
22
|
+
|
|
23
|
+
Use this format after each pass (starting with Pass 2).
|
|
24
|
+
|
|
25
|
+
```markdown
|
|
26
|
+
**Convergence Check After Pass [N]:**
|
|
27
|
+
|
|
28
|
+
1. New CRITICAL issues: [count]
|
|
29
|
+
2. Total new issues this pass: [count]
|
|
30
|
+
3. Total new issues previous pass: [count]
|
|
31
|
+
4. Estimated false positive rate: [percentage]
|
|
32
|
+
|
|
33
|
+
**Status:** [CONVERGED | ITERATE | NEEDS_HUMAN]
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Final Report Template
|
|
37
|
+
|
|
38
|
+
After convergence or completing all 5 passes, provide this summary.
|
|
39
|
+
|
|
40
|
+
```markdown
|
|
41
|
+
# Research Review Final Report
|
|
42
|
+
|
|
43
|
+
**Research:** [path/to/research.md] | **Convergence:** Pass [N]
|
|
44
|
+
|
|
45
|
+
## Summary Table
|
|
46
|
+
| Severity | Count | Key Focus |
|
|
47
|
+
| :--- | :--- | :--- |
|
|
48
|
+
| **CRITICAL** | [count] | Factual Accuracy / Evidence |
|
|
49
|
+
| **HIGH** | [count] | Analysis Gaps / Conclusions |
|
|
50
|
+
| **MEDIUM** | [count] | Actionability / Clarity |
|
|
51
|
+
| **LOW** | [count] | Metadata / Flow |
|
|
52
|
+
|
|
53
|
+
## Research Quality Assessment
|
|
54
|
+
- **Accuracy**: [Excellent|Good|Fair|Poor] - [brief comment]
|
|
55
|
+
- **Completeness**: [Excellent|Good|Fair|Poor] - [brief comment]
|
|
56
|
+
- **Actionability**: [Excellent|Good|Fair|Poor] - [brief comment]
|
|
57
|
+
- **Clarity**: [Excellent|Good|Fair|Poor] - [brief comment]
|
|
58
|
+
|
|
59
|
+
## Top 3 Critical Findings
|
|
60
|
+
1. **[ID] [Description]** - [Section]
|
|
61
|
+
* **Impact:** [Why this leads to bad decisions or is factually wrong]
|
|
62
|
+
* **Fix:** [Specific actionable step]
|
|
63
|
+
|
|
64
|
+
2. **[ID] ...**
|
|
65
|
+
|
|
66
|
+
## Recommended Next Actions
|
|
67
|
+
1. [Action 1 - specific and actionable]
|
|
68
|
+
2. [Action 2 - specific and actionable]
|
|
69
|
+
3. [Action 3 - specific and actionable]
|
|
70
|
+
|
|
71
|
+
## Verdict: [READY | NEEDS_REVISION | NEEDS_MORE_RESEARCH]
|
|
72
|
+
**Rationale:** [1-2 sentences explaining the verdict based on evidence quality]
|
|
73
|
+
```
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: resonant-refactor
|
|
3
|
+
description: "Safe, human-approved refactoring workflow with impact analysis, atomic execution, and automatic rollback"
|
|
4
|
+
metadata:
|
|
5
|
+
installed-from: "incitaciones"
|
|
6
|
+
---
|
|
7
|
+
<!-- Full version: content/prompt-workflow-resonant-refactor.md -->
|
|
8
|
+
You are a Refactoring Specialist. Perform precise, verified, reversible changes. Do NOT touch any files before the human approves the plan.
|
|
9
|
+
|
|
10
|
+
**TASK**: Refactor to use [DESCRIBE ABSTRACTION/CHANGE]. Target: [FILES OR "discover via analysis"]
|
|
11
|
+
|
|
12
|
+
**Phase 1 — Impact Analysis** (no code changes yet):
|
|
13
|
+
- Find all usage sites via grep/search
|
|
14
|
+
- List every file that will be modified
|
|
15
|
+
- Predict side effects (API changes, type changes, edge cases)
|
|
16
|
+
- Assign risk: Low / Medium / High with one-sentence justification
|
|
17
|
+
|
|
18
|
+
**Phase 2 — Shadow Test** (no code changes yet):
|
|
19
|
+
- Identify existing tests covering the changed code
|
|
20
|
+
- Run them NOW to establish a baseline — if any fail before changes, STOP and report
|
|
21
|
+
- If tests are known flaky, run 3 times; record baseline failure rate; only rollback if execution exceeds baseline
|
|
22
|
+
- If no tests: write a minimal manual verification checklist
|
|
23
|
+
|
|
24
|
+
**Phase 3 — Human Latch** (REQUIRED STOP):
|
|
25
|
+
Output this block and wait for "APPROVE":
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
REFACTOR PLAN — APPROVAL REQUIRED
|
|
29
|
+
Abstraction: [name]
|
|
30
|
+
Files to modify: [N files — list]
|
|
31
|
+
Impact: [what changes, what stays]
|
|
32
|
+
Risk: [Low/Med/High] — [justification]
|
|
33
|
+
Verification: [test command or manual steps]
|
|
34
|
+
Rollback: `git reset --hard HEAD` restores all changes
|
|
35
|
+
|
|
36
|
+
Reply APPROVE to begin.
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
**Phase 4 — Atomic Execution** (after APPROVE):
|
|
40
|
+
Do NOT commit or stage files during execution — working tree only. This ensures rollback covers all changes.
|
|
41
|
+
|
|
42
|
+
For each file: apply change → run verification → report "✓ [file] — passed" or "✗ [file] — [error]"
|
|
43
|
+
|
|
44
|
+
Self-correction: on failure, attempt fix up to 3 times. If all 3 fail: run `git reset --hard HEAD`, report the error, stop.
|
|
45
|
+
|
|
46
|
+
**Phase 5 — Quality Gates**:
|
|
47
|
+
- Run linter on modified files
|
|
48
|
+
- Run full test suite
|
|
49
|
+
- Add docstring to new abstraction: what it does, why it exists, parameters
|
|
50
|
+
|
|
51
|
+
**Completion Report**: files modified, verification pass/fail, linter pass/fail, tests pass/fail, abstraction documented, recommended next step.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: resume-handoff
|
|
3
|
+
description: "Continue work from a previous session's handoff document"
|
|
4
|
+
metadata:
|
|
5
|
+
installed-from: "incitaciones"
|
|
6
|
+
---
|
|
7
|
+
# Resume from Handoff
|
|
8
|
+
|
|
9
|
+
Resume work from a handoff document through analysis and verification.
|
|
10
|
+
|
|
11
|
+
## Procedure
|
|
12
|
+
|
|
13
|
+
1. Locate the handoff file.
|
|
14
|
+
2. Read it completely.
|
|
15
|
+
3. Extract current status, critical files, learnings, open questions, and next steps.
|
|
16
|
+
4. Verify how the repository changed since the handoff.
|
|
17
|
+
5. Read the referenced critical files.
|
|
18
|
+
6. Present the current situation using `references/analysis-template.md`.
|
|
19
|
+
7. Wait for confirmation before starting new work.
|
|
20
|
+
|
|
21
|
+
## Rules
|
|
22
|
+
|
|
23
|
+
- Always verify the handoff against the current codebase.
|
|
24
|
+
- Treat stale handoffs as possibly inaccurate.
|
|
25
|
+
- Preserve the original priorities unless the current repository invalidates them.
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
```text
|
|
2
|
+
I've analyzed the handoff from [date]. Here's the current situation:
|
|
3
|
+
|
|
4
|
+
## Original Context
|
|
5
|
+
[Summary of what was being worked on]
|
|
6
|
+
|
|
7
|
+
## Task Status Review
|
|
8
|
+
|
|
9
|
+
Completed:
|
|
10
|
+
- [x] [Task] - VERIFIED: [Current status]
|
|
11
|
+
|
|
12
|
+
In Progress:
|
|
13
|
+
- [ ] [Task] - STATUS: [Current state]
|
|
14
|
+
|
|
15
|
+
Planned:
|
|
16
|
+
- [ ] [Next task]
|
|
17
|
+
|
|
18
|
+
## Changes Since Handoff
|
|
19
|
+
|
|
20
|
+
Commits since handoff:
|
|
21
|
+
- [Commit summary]
|
|
22
|
+
|
|
23
|
+
Impact:
|
|
24
|
+
[How the current state affects the original plan]
|
|
25
|
+
|
|
26
|
+
## Key Learnings Still Applicable
|
|
27
|
+
|
|
28
|
+
1. [Learning] - [Why it still applies or not]
|
|
29
|
+
|
|
30
|
+
## Questions Needing Resolution
|
|
31
|
+
|
|
32
|
+
- [ ] [Question]
|
|
33
|
+
|
|
34
|
+
## Recommended Next Action
|
|
35
|
+
|
|
36
|
+
Priority 1: [Action]
|
|
37
|
+
- Reason: [Why]
|
|
38
|
+
- Files: [What to read or change]
|
|
39
|
+
- Approach: [How to proceed]
|
|
40
|
+
```
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: review-documentation
|
|
3
|
+
description: "Iterative review of documentation for cognitive scannability and AI-readiness"
|
|
4
|
+
metadata:
|
|
5
|
+
installed-from: "incitaciones"
|
|
6
|
+
---
|
|
7
|
+
# Review Documentation Quality
|
|
8
|
+
|
|
9
|
+
Perform a Rule of 5 review of the documentation using the Unified Frameworks for Technical Information Architecture.
|
|
10
|
+
|
|
11
|
+
## REVIEW PROCESS
|
|
12
|
+
|
|
13
|
+
Perform 5 iterative passes, checking for convergence after each pass (starting with pass 2).
|
|
14
|
+
|
|
15
|
+
### PASS 1: Diátaxis & Intent
|
|
16
|
+
- **Goal:** Does this topic have a single, clear intent?
|
|
17
|
+
- **Checks:** Is it a Tutorial, How-to, Reference, or Explanation? Are there "leaked" intents? (e.g., too much theory in a Tutorial).
|
|
18
|
+
- **Issue Prefix:** [INTENT-001]
|
|
19
|
+
|
|
20
|
+
### PASS 2: EPPO & Standalone Utility
|
|
21
|
+
- **Goal:** Can a "foraging" reader land here and succeed?
|
|
22
|
+
- **Checks:** Are context and prerequisites established in the first two sentences? Does it rely on "previous chapter" knowledge without links?
|
|
23
|
+
- **Issue Prefix:** [EPPO-001]
|
|
24
|
+
|
|
25
|
+
### PASS 3: Cognitive Scannability (Info Mapping)
|
|
26
|
+
- **Goal:** Can the reader scan the page in <10 seconds and find the key answer?
|
|
27
|
+
- **Checks:** Are **labels** (descriptive headers) used for every 2-3 paragraphs? Are paragraphs chunked into small units? Are there tables/lists for complex data?
|
|
28
|
+
- **Issue Prefix:** [SCAN-001]
|
|
29
|
+
|
|
30
|
+
### PASS 4: Accuracy, "Whole Game" & Fail-States
|
|
31
|
+
- **Goal:** Is the content technically sound and resilient?
|
|
32
|
+
- **Checks:** Are the code snippets/math verified? Does it show the "Whole Game" (complete result)? Are common errors (fail-states) documented? In tutorials, is the **Martini Glass** pattern followed (context → exploration)?
|
|
33
|
+
- **Issue Prefix:** [ACC-001]
|
|
34
|
+
|
|
35
|
+
### PASS 5: Excellence & AI-Readiness
|
|
36
|
+
- **Goal:** Is it production-ready and optimized for AI agents?
|
|
37
|
+
- **Checks:** Is there a TL;DR for LLMs? Are headers semantically unique for RAG? Is the **Answer First** (Pyramid Principle) located in the TL;DR and first paragraph?
|
|
38
|
+
- **Issue Prefix:** [EXCL-001]
|
|
39
|
+
|
|
40
|
+
## Convergence Check
|
|
41
|
+
After each pass (starting with pass 2), report:
|
|
42
|
+
- Total new issues found.
|
|
43
|
+
- Estimated "Signal-to-Noise" ratio.
|
|
44
|
+
- Convergence status: (CONVERGED | CONTINUE).
|
|
45
|
+
|
|
46
|
+
## Final Report Format
|
|
47
|
+
- **Total Issues by Severity** (Critical | High | Medium | Low).
|
|
48
|
+
- **Top 3 Findings.**
|
|
49
|
+
- **Verdict:** (Ready | Needs Revision | Needs Rework).
|
|
50
|
+
- **Rationale.**
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: rigidity-diagnostician
|
|
3
|
+
description: "Diagnose structural rigidity from excessive coupling, inheritance, and OCP violations, then map findings to composition-based remediation patterns"
|
|
4
|
+
metadata:
|
|
5
|
+
installed-from: "incitaciones"
|
|
6
|
+
---
|
|
7
|
+
<!-- Full version: content/prompt-task-rigidity-diagnostician.md -->
|
|
8
|
+
You are a Software Architecture Analyst. Diagnose structural rigidity — cascading change resistance caused by excessive coupling, inappropriate inheritance, and OCP violations — and map each finding to a composition-based remediation pattern. Do NOT modify any files — advisory only.
|
|
9
|
+
|
|
10
|
+
**GUARD:** Do not apply to greenfield projects, inter-service rigidity (API contracts between microservices), or languages with no polymorphism mechanism (no interfaces, abstract types, first-class functions, function pointers, or equivalent). Do not recommend composition patterns for stable code with no historical change pressure — flag as premature abstraction risk instead.
|
|
11
|
+
|
|
12
|
+
**INPUT**
|
|
13
|
+
- Target files/directory: [SPECIFY]
|
|
14
|
+
- High-churn files (optional): [git log output OR "none"]
|
|
15
|
+
- Architecture reference (optional): [AGENTS.md rules OR "none"]
|
|
16
|
+
- Paradigm (optional): [OOP / FP / Mixed — or "infer"]
|
|
17
|
+
|
|
18
|
+
**PROTOCOL (Six-Step Pipeline)**
|
|
19
|
+
|
|
20
|
+
Step 1 — Detect Code Smells: Read all files. Identify rigidity signals:
|
|
21
|
+
- God Class / Large File (High): many responsibilities, many dependencies
|
|
22
|
+
- Long Methods / Excessive Parameters (High): 50+ lines, 5+ params (adjust for language norms — Go option structs, Rust generics are not inherently problematic)
|
|
23
|
+
- Feature Envy (High): methods accessing another object's data more than their own
|
|
24
|
+
- Duplicated Conditional Logic (High): same switch/if-else in multiple locations
|
|
25
|
+
- Fragile Base Class (High): deep inheritance (3+ levels) where base changes break subclasses
|
|
26
|
+
- Duplicated Code (Medium): structurally similar blocks with minor variations
|
|
27
|
+
- Shotgun Surgery (Medium): single conceptual change requires edits across many files
|
|
28
|
+
- Lazy Classes (Low): classes doing too little to justify their complexity cost
|
|
29
|
+
Note file, line range, and description for each.
|
|
30
|
+
|
|
31
|
+
Step 2 — Analyze Coupling: For each smell, assess coupling type:
|
|
32
|
+
- Static: direct `new`, concrete types in signatures
|
|
33
|
+
- Inheritance: deep extends/inherits chains, override dependencies
|
|
34
|
+
- Temporal: required call ordering
|
|
35
|
+
- Semantic: no code dependency but must change together
|
|
36
|
+
- Data: shared mutable state, globals, singletons
|
|
37
|
+
Rate severity: Isolated (local) / Moderate (2-3 files) / Cascading (4+ files).
|
|
38
|
+
|
|
39
|
+
Step 3 — Identify Axes of Change: Ask: "Can this module be replaced without changing others?" Categorize via DDD strategic design's 3 Buckets (Evans/Vernon):
|
|
40
|
+
- Core Domain (high volatility → OCP critical)
|
|
41
|
+
- Supporting Subdomain (moderate → composition beneficial)
|
|
42
|
+
- Generic Component (low → concrete implementations acceptable)
|
|
43
|
+
If git churn data provided, cross-reference: tightly coupled + frequently modified = highest priority.
|
|
44
|
+
|
|
45
|
+
Step 4 — Diagnose OCP Violations: Check for:
|
|
46
|
+
1. Switch/if-else chains branching on type — new variant requires modifying existing code
|
|
47
|
+
2. Repeated methods of identical structure — new variant demands new method
|
|
48
|
+
3. Hardcoded conditional logic — business rules embedded in execution flow
|
|
49
|
+
4. Data-driven rigidity — adding peer entity requires source modification
|
|
50
|
+
Flag whether violation is at a volatile axis (high priority) or stable area (lower — avoid premature abstraction).
|
|
51
|
+
|
|
52
|
+
Step 5 — Map to Composition Pattern:
|
|
53
|
+
- Switch on type → **Strategy**: interface + concrete implementations per branch
|
|
54
|
+
- Subclass explosion → **Decorator**: composable layers sharing same interface
|
|
55
|
+
- Lifecycle state conditionals → **State**: state interface + concrete state classes
|
|
56
|
+
- Part-whole hierarchies → **Composite**: tree with shared interface
|
|
57
|
+
- Rigid step ordering → **Pipeline/Chain of Responsibility**: composable middleware
|
|
58
|
+
- Deep inheritance → **Composition refactoring** (4-step): analyze → extract interface → inject → flatten
|
|
59
|
+
- Repeated method shapes → **Data-driven config**: config objects + delegates
|
|
60
|
+
|
|
61
|
+
FP equivalents: Strategy→higher-order function, State→sum types+pattern matching, Decorator→function composition, Config→first-class functions in data structures.
|
|
62
|
+
|
|
63
|
+
Step 6 — Prioritize: Score = Coupling Severity (Cascading=3, Moderate=2, Isolated=1) × Change Frequency (High=3, Moderate=2, Stable=1) × Axis Volatility (Core=3, Supporting=2, Generic=1). If no git data, estimate churn from structural signals: TODO/FIXME density, feature-flag conditionals, version-specific branches suggest high churn; stable utilities with no branching suggest low. Sequence so foundational abstractions come first, high-priority unblocking items lead, each step is independently deployable.
|
|
64
|
+
|
|
65
|
+
**OUTPUT**
|
|
66
|
+
|
|
67
|
+
Summary table:
|
|
68
|
+
| Location | Code Smell | Coupling Type | OCP Violation | Composition Pattern | Priority |
|
|
69
|
+
|
|
70
|
+
If multiple smells share a root cause, consolidate. Then per finding: smell (files, lines), coupling analysis (type + blast radius), axis of change (bucket + volatility), OCP violation (how modification is forced), recommended pattern (interface name, key classes, injection point — no full implementation), refactoring sequence (safe steps, never change behavior and structure simultaneously), success signals (fewer files per feature, switches eliminated, new variants via new classes only).
|
|
71
|
+
|
|
72
|
+
Needs Human Review: list ambiguous cases — intentional tight coupling (performance), potential speculative generality, composition trade-offs that may not justify flexibility, inheritance that models genuine stable taxonomy.
|
|
73
|
+
|
|
74
|
+
If no signals found: "No rigidity signals found. Codebase exhibits clean separation and appropriate composition at identified axes of change." Do not fabricate findings.
|
|
75
|
+
|
|
76
|
+
Stop when all files analyzed. Do not modify anything.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: rule-of-5-universal
|
|
3
|
+
description: "Steve Yegge's original 5-stage review for any artifact"
|
|
4
|
+
metadata:
|
|
5
|
+
installed-from: "incitaciones"
|
|
6
|
+
---
|
|
7
|
+
# Universal Rule of 5 Review
|
|
8
|
+
|
|
9
|
+
Review any intellectual artifact (code, plans, research, issues, specs, documentation) using Steve Yegge's 5-stage iterative editorial refinement process until convergence.
|
|
10
|
+
|
|
11
|
+
## Core Philosophy
|
|
12
|
+
"Breadth-first exploration, then editorial passes." Don't aim for perfection in early stages. Each stage builds on insights from previous stages.
|
|
13
|
+
|
|
14
|
+
## Procedure
|
|
15
|
+
1. **Stage 1: DRAFT** - Evaluate overall shape and sound approach. Focus on architecture, organization, and scope.
|
|
16
|
+
2. **Stage 2: CORRECTNESS** - Identify errors, bugs, or logical flaws. Check for convergence.
|
|
17
|
+
3. **Stage 3: CLARITY** - Ensure comprehensibility for the intended audience. Check for convergence.
|
|
18
|
+
4. **Stage 4: EDGE CASES** - Handle boundary conditions and unusual scenarios. Check for convergence.
|
|
19
|
+
5. **Stage 5: EXCELLENCE** - Final polish for production quality and pride.
|
|
20
|
+
6. **Final Report** - Synthesize findings and provide a final verdict.
|
|
21
|
+
|
|
22
|
+
## Rules
|
|
23
|
+
- **Progressive Build:** Each stage must build on previous findings.
|
|
24
|
+
- **Specificity:** Reference exact locations (file:line, section, paragraph).
|
|
25
|
+
- **Actionability:** Suggest specific solutions, don't just identify problems.
|
|
26
|
+
- **Validation:** Confirm issues exist; do not flag "potential" issues without evidence.
|
|
27
|
+
- **Early Stop:** Stop if convergence criteria are met before Stage 5.
|
|
28
|
+
|
|
29
|
+
## References
|
|
30
|
+
- **Templates:** Use `references/templates.md` for the exact output format of each stage and the final report.
|
|
31
|
+
- **Criteria:** Refer to `references/criteria.md` for convergence and escalation rules.
|
|
32
|
+
- **Examples:** (Optional) See `references/examples.md` for domain-specific review examples.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Rule of 5 Convergence & Escalation Criteria
|
|
2
|
+
|
|
3
|
+
## Convergence Check
|
|
4
|
+
Perform this check after Stage 2, Stage 3, and Stage 4.
|
|
5
|
+
|
|
6
|
+
```
|
|
7
|
+
New CRITICAL issues: [count]
|
|
8
|
+
Total new issues: [count]
|
|
9
|
+
New issues vs Previous Stage: [percentage change]
|
|
10
|
+
Status: [CONVERGED | CONTINUE]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Convergence Rules
|
|
14
|
+
- **CONVERGED** if:
|
|
15
|
+
- No new CRITICAL issues AND
|
|
16
|
+
- New issue rate < 10% vs previous stage AND
|
|
17
|
+
- False positive rate < 20%
|
|
18
|
+
- **CONTINUE** if:
|
|
19
|
+
- New issues found that need addressing and do not meet the above criteria.
|
|
20
|
+
|
|
21
|
+
## Escalation Rules
|
|
22
|
+
- **ESCALATE_TO_HUMAN** if:
|
|
23
|
+
- After 5 stages, still finding CRITICAL issues OR
|
|
24
|
+
- Uncertain about severity or correctness OR
|
|
25
|
+
- False positive rate > 30%
|
|
26
|
+
|
|
27
|
+
## Convergence Check Output Format
|
|
28
|
+
```
|
|
29
|
+
New CRITICAL issues: [count]
|
|
30
|
+
Total new issues: [count]
|
|
31
|
+
New issues vs Previous Stage: [percentage change]
|
|
32
|
+
Estimated false positive rate: [percentage]
|
|
33
|
+
Status: [CONVERGED | CONTINUE | NEEDS_ITERATION | ESCALATE_TO_HUMAN]
|
|
34
|
+
```
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# Rule of 5 Domain-Specific Examples
|
|
2
|
+
|
|
3
|
+
## Example 1: Code Review
|
|
4
|
+
|
|
5
|
+
**Input:**
|
|
6
|
+
```python
|
|
7
|
+
def process_users(users):
|
|
8
|
+
results = []
|
|
9
|
+
for user in users:
|
|
10
|
+
if user.age > 18:
|
|
11
|
+
results.append(user.name.upper())
|
|
12
|
+
return results
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
**Output (abbreviated):**
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
STAGE 1: DRAFT
|
|
19
|
+
Shape Quality: GOOD - Simple function, clear structure
|
|
20
|
+
|
|
21
|
+
STAGE 2: CORRECTNESS
|
|
22
|
+
[CORR-001] HIGH - Line 4
|
|
23
|
+
Description: No null check on user.name
|
|
24
|
+
Evidence: Will crash if user.name is None
|
|
25
|
+
Recommendation: Add null check: `if user.name: results.append(user.name.upper())`
|
|
26
|
+
|
|
27
|
+
STAGE 3: CLARITY
|
|
28
|
+
[CLAR-001] MEDIUM - Function name
|
|
29
|
+
Description: "process_users" is vague
|
|
30
|
+
Recommendation: Rename to "get_adult_user_names_uppercase"
|
|
31
|
+
|
|
32
|
+
STAGE 4: EDGE CASES
|
|
33
|
+
[EDGE-001] HIGH - Line 2
|
|
34
|
+
Description: Empty users list not handled efficiently
|
|
35
|
+
Recommendation: Add early return: `if not users: return []`
|
|
36
|
+
|
|
37
|
+
STAGE 5: EXCELLENCE
|
|
38
|
+
Production Ready: WITH_NOTES - Fix CORR-001 and EDGE-001 first
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Example 2: Plan Review
|
|
42
|
+
|
|
43
|
+
**Input:** Plan for implementing user authentication
|
|
44
|
+
|
|
45
|
+
**Output (abbreviated):**
|
|
46
|
+
|
|
47
|
+
```
|
|
48
|
+
STAGE 1: DRAFT
|
|
49
|
+
Shape Quality: FAIR - Missing rollback phase and testing phase
|
|
50
|
+
|
|
51
|
+
STAGE 2: CORRECTNESS
|
|
52
|
+
[CORR-001] CRITICAL - Phase 3
|
|
53
|
+
Description: Assumes JWT library handles all validation automatically
|
|
54
|
+
Evidence: Most libraries require explicit error handling
|
|
55
|
+
Recommendation: Add error handling to Phase 3, add test for invalid tokens
|
|
56
|
+
|
|
57
|
+
STAGE 3: CLARITY
|
|
58
|
+
[CLAR-001] HIGH - Phase 2
|
|
59
|
+
Description: "Integrate with auth system" is vague
|
|
60
|
+
Recommendation: Specify files: "Update api/middleware/auth.ts and api/routes/protected.ts"
|
|
61
|
+
|
|
62
|
+
STAGE 4: EDGE CASES
|
|
63
|
+
[EDGE-001] HIGH - Overall
|
|
64
|
+
Description: No plan for token expiration or refresh
|
|
65
|
+
Recommendation: Add Phase 4 for token refresh mechanism or mark as out of scope
|
|
66
|
+
|
|
67
|
+
STAGE 5: EXCELLENCE
|
|
68
|
+
Production Ready: NO - Fix CORR-001 and add missing phases
|
|
69
|
+
```
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
# Rule of 5 Output Templates
|
|
2
|
+
|
|
3
|
+
Use these templates for each stage of the review and the final report.
|
|
4
|
+
|
|
5
|
+
## Stage 1: DRAFT
|
|
6
|
+
```
|
|
7
|
+
STAGE 1: DRAFT
|
|
8
|
+
|
|
9
|
+
Assessment: [1-2 sentences on overall shape]
|
|
10
|
+
|
|
11
|
+
Major Issues:
|
|
12
|
+
[DRAFT-001] [CRITICAL|HIGH|MEDIUM|LOW] - [Location]
|
|
13
|
+
Description: [What's wrong structurally]
|
|
14
|
+
Recommendation: [How to fix]
|
|
15
|
+
|
|
16
|
+
[DRAFT-002] ...
|
|
17
|
+
|
|
18
|
+
Shape Quality: [EXCELLENT|GOOD|FAIR|POOR]
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Stage 2: CORRECTNESS
|
|
22
|
+
```
|
|
23
|
+
STAGE 2: CORRECTNESS
|
|
24
|
+
|
|
25
|
+
Issues Found:
|
|
26
|
+
[CORR-001] [CRITICAL|HIGH|MEDIUM|LOW] - [Location]
|
|
27
|
+
Description: [What's incorrect]
|
|
28
|
+
Evidence: [Why this is wrong]
|
|
29
|
+
Recommendation: [How to fix with specifics]
|
|
30
|
+
|
|
31
|
+
[CORR-002] ...
|
|
32
|
+
|
|
33
|
+
Correctness Quality: [EXCELLENT|GOOD|FAIR|POOR]
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Stage 3: CLARITY
|
|
37
|
+
```
|
|
38
|
+
STAGE 3: CLARITY
|
|
39
|
+
|
|
40
|
+
Issues Found:
|
|
41
|
+
[CLAR-001] [HIGH|MEDIUM|LOW] - [Location]
|
|
42
|
+
Description: [What's unclear]
|
|
43
|
+
Impact: [Why this matters]
|
|
44
|
+
Recommendation: [How to improve clarity]
|
|
45
|
+
|
|
46
|
+
[CLAR-002] ...
|
|
47
|
+
|
|
48
|
+
Clarity Quality: [EXCELLENT|GOOD|FAIR|POOR]
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Stage 4: EDGE CASES
|
|
52
|
+
```
|
|
53
|
+
STAGE 4: EDGE CASES
|
|
54
|
+
|
|
55
|
+
Issues Found:
|
|
56
|
+
[EDGE-001] [CRITICAL|HIGH|MEDIUM|LOW] - [Location]
|
|
57
|
+
Description: [What edge case is unhandled]
|
|
58
|
+
Scenario: [When this could happen]
|
|
59
|
+
Impact: [What goes wrong]
|
|
60
|
+
Recommendation: [How to handle it]
|
|
61
|
+
|
|
62
|
+
[EDGE-002] ...
|
|
63
|
+
|
|
64
|
+
Edge Case Coverage: [EXCELLENT|GOOD|FAIR|POOR]
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Stage 5: EXCELLENCE
|
|
68
|
+
```
|
|
69
|
+
STAGE 5: EXCELLENCE
|
|
70
|
+
|
|
71
|
+
Final Polish Issues:
|
|
72
|
+
[EXCL-001] [HIGH|MEDIUM|LOW] - [Location]
|
|
73
|
+
Description: [What could be better]
|
|
74
|
+
Recommendation: [How to achieve excellence]
|
|
75
|
+
|
|
76
|
+
[EXCL-002] ...
|
|
77
|
+
|
|
78
|
+
Excellence Assessment:
|
|
79
|
+
- Structure: [EXCELLENT|GOOD|FAIR|POOR]
|
|
80
|
+
- Correctness: [EXCELLENT|GOOD|FAIR|POOR]
|
|
81
|
+
- Clarity: [EXCELLENT|GOOD|FAIR|POOR]
|
|
82
|
+
- Edge Cases: [EXCELLENT|GOOD|FAIR|POOR]
|
|
83
|
+
- Overall: [EXCELLENT|GOOD|FAIR|POOR]
|
|
84
|
+
|
|
85
|
+
Production Ready: [YES|NO|WITH_NOTES]
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Final Report
|
|
89
|
+
```
|
|
90
|
+
# Rule of 5 Review - Final Report
|
|
91
|
+
|
|
92
|
+
**Work Reviewed:** [type] - [path/identifier]
|
|
93
|
+
**Convergence:** Stage [N]
|
|
94
|
+
|
|
95
|
+
## Summary
|
|
96
|
+
|
|
97
|
+
Total Issues by Severity:
|
|
98
|
+
- CRITICAL: [count] - Must fix before proceeding
|
|
99
|
+
- HIGH: [count] - Should fix before proceeding
|
|
100
|
+
- MEDIUM: [count] - Consider addressing
|
|
101
|
+
- LOW: [count] - Nice to have
|
|
102
|
+
|
|
103
|
+
## Top 3 Critical Findings
|
|
104
|
+
|
|
105
|
+
1. [ID] [Description] - [Location]
|
|
106
|
+
Impact: [Why this matters]
|
|
107
|
+
Fix: [What to do]
|
|
108
|
+
|
|
109
|
+
2. [ID] [Description] - [Location]
|
|
110
|
+
Impact: [Why this matters]
|
|
111
|
+
Fix: [What to do]
|
|
112
|
+
|
|
113
|
+
3. [ID] [Description] - [Location]
|
|
114
|
+
Impact: [Why this matters]
|
|
115
|
+
Fix: [What to do]
|
|
116
|
+
|
|
117
|
+
## Stage-by-Stage Quality
|
|
118
|
+
|
|
119
|
+
- Stage 1 (Draft): [Quality assessment]
|
|
120
|
+
- Stage 2 (Correctness): [Quality assessment]
|
|
121
|
+
- Stage 3 (Clarity): [Quality assessment]
|
|
122
|
+
- Stage 4 (Edge Cases): [Quality assessment]
|
|
123
|
+
- Stage 5 (Excellence): [Quality assessment]
|
|
124
|
+
|
|
125
|
+
## Recommended Actions
|
|
126
|
+
|
|
127
|
+
1. [Action 1 - specific and actionable]
|
|
128
|
+
2. [Action 2 - specific and actionable]
|
|
129
|
+
3. [Action 3 - specific and actionable]
|
|
130
|
+
|
|
131
|
+
## Verdict
|
|
132
|
+
|
|
133
|
+
[READY | NEEDS_REVISION | NEEDS_REWORK | NOT_READY]
|
|
134
|
+
|
|
135
|
+
**Rationale:** [1-2 sentences explaining the verdict]
|
|
136
|
+
```
|