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,34 @@
|
|
|
1
|
+
## Problem Definition
|
|
2
|
+
|
|
3
|
+
Define the outcome precisely before investigating causes.
|
|
4
|
+
|
|
5
|
+
### Required Elements
|
|
6
|
+
|
|
7
|
+
1. **WHAT** — Specific observable outcome (not interpretation)
|
|
8
|
+
2. **WHERE** — System, component, location, scope
|
|
9
|
+
3. **WHEN** — First detection, duration, resolution
|
|
10
|
+
4. **SEVERITY** — Impact on users, safety, business, compliance
|
|
11
|
+
5. **OUT OF SCOPE** — What this investigation does not cover
|
|
12
|
+
|
|
13
|
+
### Counterfactual
|
|
14
|
+
|
|
15
|
+
State the expected/normal behavior and what changed relative to that baseline. This anchors the investigation — without a counterfactual, you cannot distinguish cause from background condition.
|
|
16
|
+
|
|
17
|
+
### Red Flags
|
|
18
|
+
|
|
19
|
+
- Problem statement contains solutions ("we need to add...")
|
|
20
|
+
- Describes a symptom without measurable specificity ("the system is slow")
|
|
21
|
+
- No severity assessment — all problems feel urgent without scoping
|
|
22
|
+
- Scope is unbounded — investigation will grow without limit
|
|
23
|
+
|
|
24
|
+
### Output
|
|
25
|
+
|
|
26
|
+
```text
|
|
27
|
+
## Problem Definition
|
|
28
|
+
|
|
29
|
+
Outcome: [precise statement]
|
|
30
|
+
Measurement: [how detected/measured]
|
|
31
|
+
Severity: [impact assessment]
|
|
32
|
+
Counterfactual: [expected vs. actual]
|
|
33
|
+
Scope boundary: [in scope / out of scope]
|
|
34
|
+
```
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
```text
|
|
2
|
+
# RCA Diagnostician Report
|
|
3
|
+
|
|
4
|
+
Date: [YYYY-MM-DD]
|
|
5
|
+
Mode: [INVESTIGATE | EVALUATE]
|
|
6
|
+
Domain: [discipline/context]
|
|
7
|
+
|
|
8
|
+
## Problem Definition
|
|
9
|
+
|
|
10
|
+
Outcome: [precise statement of what failed]
|
|
11
|
+
Measurement: [how detected/measured]
|
|
12
|
+
Severity: [impact assessment]
|
|
13
|
+
Counterfactual: [expected vs. actual behavior]
|
|
14
|
+
Scope boundary: [in scope / out of scope]
|
|
15
|
+
|
|
16
|
+
## Evidence Summary
|
|
17
|
+
|
|
18
|
+
Sources: [count] across [count] independent streams
|
|
19
|
+
Sufficiency: [MET | GAP — describe]
|
|
20
|
+
|
|
21
|
+
## Timeline (key events)
|
|
22
|
+
|
|
23
|
+
| Time | Event | Source |
|
|
24
|
+
|------|-------|--------|
|
|
25
|
+
| [when] | [what happened] | [evidence source] |
|
|
26
|
+
|
|
27
|
+
## Root Causes Identified
|
|
28
|
+
|
|
29
|
+
| # | Level | Root cause | Confidence | Key evidence |
|
|
30
|
+
|---|-------|-----------|------------|--------------|
|
|
31
|
+
| 1 | [mechanism/process/org] | [cause] | [high/medium/low] | [supporting evidence] |
|
|
32
|
+
|
|
33
|
+
## Bias Check Summary
|
|
34
|
+
|
|
35
|
+
- Confirmation bias: [CLEAR | FLAG]
|
|
36
|
+
- Blame displacement: [CLEAR | FLAG]
|
|
37
|
+
- Correlation-causation: [CLEAR | FLAG]
|
|
38
|
+
- Early closure: [CLEAR | FLAG]
|
|
39
|
+
|
|
40
|
+
Countermeasure actions taken: [what was done to mitigate flagged biases]
|
|
41
|
+
|
|
42
|
+
## Corrective Actions
|
|
43
|
+
|
|
44
|
+
| # | Root cause | Action | Strength | Owner | Deadline | Verification metric | Monitoring period |
|
|
45
|
+
|---|-----------|--------|----------|-------|----------|--------------------|--------------------|
|
|
46
|
+
| 1 | [cause] | [action] | [strong/intermediate/weak] | [who] | [when] | [metric] | [duration] |
|
|
47
|
+
|
|
48
|
+
Action strength mix: [N strong, N intermediate, N weak]
|
|
49
|
+
Minimum strong action: [MET | NOT MET]
|
|
50
|
+
|
|
51
|
+
## Rigor Assessment
|
|
52
|
+
|
|
53
|
+
Overall: [STRONG | ADEQUATE | WEAK | INSUFFICIENT]
|
|
54
|
+
Key gaps: [list any PARTIAL or NOT MET criteria]
|
|
55
|
+
|
|
56
|
+
## Recommendations
|
|
57
|
+
|
|
58
|
+
1. [Most critical action — with owner and deadline]
|
|
59
|
+
2. [Next priority]
|
|
60
|
+
3. [Follow-up or monitoring action]
|
|
61
|
+
|
|
62
|
+
## Open Questions
|
|
63
|
+
|
|
64
|
+
- [What remains uncertain]
|
|
65
|
+
- [What evidence is still needed]
|
|
66
|
+
- [What assumptions should be monitored]
|
|
67
|
+
|
|
68
|
+
## Learning Loop
|
|
69
|
+
|
|
70
|
+
- Standards to update: [list]
|
|
71
|
+
- Training to modify: [list]
|
|
72
|
+
- Design reviews to inform: [list]
|
|
73
|
+
- Monitoring to add/change: [list]
|
|
74
|
+
- Audit/compliance to introduce: [list]
|
|
75
|
+
```
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
## Rigor Evaluation Checklist
|
|
2
|
+
|
|
3
|
+
Apply to your own RCA (self-check) or to an existing report (EVALUATE mode).
|
|
4
|
+
|
|
5
|
+
### Core Criteria (always apply)
|
|
6
|
+
|
|
7
|
+
| # | Criterion | What to check | MET when |
|
|
8
|
+
|---|-----------|---------------|----------|
|
|
9
|
+
| 1 | **Problem definition** | Is the outcome measurable, time-bounded, and severity-scoped? | WHAT/WHERE/WHEN/SEVERITY all specified; no solution language embedded |
|
|
10
|
+
| 2 | **Counterfactual** | Is the expected/normal behavior stated? | Explicit baseline; change from normal identified |
|
|
11
|
+
| 3 | **Evidence sufficiency** | Are there at least three independent evidence streams? | 3+ distinct source types (records, observation, testimony, artifacts) |
|
|
12
|
+
| 4 | **Hypothesis discipline** | Were alternative hypotheses documented with falsification criteria? | 3+ candidates at different levels; disconfirming evidence sought for each |
|
|
13
|
+
| 5 | **Mechanism plausibility** | Is each claimed cause explained by mechanism, not just correlation? | "How X causes Y" stated; not just "X preceded Y" |
|
|
14
|
+
| 6 | **Action quality** | Do actions materially change system constraints? | At least 1 strong action; weak-only portfolios flagged |
|
|
15
|
+
| 7 | **Ownership** | Is there a named owner, deadline, and authority for each action? | Every action row complete |
|
|
16
|
+
| 8 | **Effectiveness verification** | Are verification metrics and monitoring periods defined? | Metric + period + escalation path for each action |
|
|
17
|
+
| 9 | **Learning loop** | Does the RCA feed back into standards, training, and monitoring? | At least one organizational update identified |
|
|
18
|
+
|
|
19
|
+
### AI Governance Criteria (apply when AI tools were used in the investigation)
|
|
20
|
+
|
|
21
|
+
| # | Criterion | What to check | MET when |
|
|
22
|
+
|---|-----------|---------------|----------|
|
|
23
|
+
| 10 | **Provenance** | Does every AI-produced claim link to evidence artifacts? | Each AI output traceable to source data |
|
|
24
|
+
| 11 | **Explainability** | Are AI outputs interpretable and connected to interventions? | Explanations are meaningful to domain practitioners |
|
|
25
|
+
| 12 | **Causal guardrails** | Were associations distinguished from causal claims? | Uncertainty stated; no bare "AI found the root cause" |
|
|
26
|
+
| 13 | **Human decision rights** | Did accountable humans review and approve findings? | Named reviewer signed off on AI-informed conclusions |
|
|
27
|
+
|
|
28
|
+
### Scoring
|
|
29
|
+
|
|
30
|
+
- **MET**: Criterion fully satisfied with evidence
|
|
31
|
+
- **PARTIAL**: Criterion addressed but with gaps or weak evidence
|
|
32
|
+
- **NOT MET**: Criterion absent or inadequate
|
|
33
|
+
|
|
34
|
+
Overall rigor (based on 9 core criteria):
|
|
35
|
+
- **STRONG**: All 9 core criteria MET
|
|
36
|
+
- **ADEQUATE**: No more than 2 PARTIAL, zero NOT MET
|
|
37
|
+
- **WEAK**: 1-2 NOT MET or 3+ PARTIAL
|
|
38
|
+
- **INSUFFICIENT**: 3+ NOT MET
|
|
39
|
+
|
|
40
|
+
AI governance criteria do not affect the core rigor score but are reported separately. If any AI governance criterion is NOT MET, append "(AI governance gaps)" to the overall rigor rating.
|
|
41
|
+
|
|
42
|
+
### Output
|
|
43
|
+
|
|
44
|
+
```text
|
|
45
|
+
## Rigor Evaluation
|
|
46
|
+
|
|
47
|
+
| # | Criterion | Status | Evidence/Gap |
|
|
48
|
+
|---|-----------|--------|-------------|
|
|
49
|
+
| 1 | Problem definition | [MET/PARTIAL/NOT MET] | [detail] |
|
|
50
|
+
| 2 | Counterfactual | [MET/PARTIAL/NOT MET] | [detail] |
|
|
51
|
+
| 3 | Evidence sufficiency | [MET/PARTIAL/NOT MET] | [detail] |
|
|
52
|
+
| 4 | Hypothesis discipline | [MET/PARTIAL/NOT MET] | [detail] |
|
|
53
|
+
| 5 | Mechanism plausibility | [MET/PARTIAL/NOT MET] | [detail] |
|
|
54
|
+
| 6 | Action quality | [MET/PARTIAL/NOT MET] | [detail] |
|
|
55
|
+
| 7 | Ownership | [MET/PARTIAL/NOT MET] | [detail] |
|
|
56
|
+
| 8 | Effectiveness verification | [MET/PARTIAL/NOT MET] | [detail] |
|
|
57
|
+
| 9 | Learning loop | [MET/PARTIAL/NOT MET] | [detail] |
|
|
58
|
+
|
|
59
|
+
AI governance (if applicable):
|
|
60
|
+
| 10 | Provenance | [MET/PARTIAL/NOT MET/N/A] | [detail] |
|
|
61
|
+
| 11 | Explainability | [MET/PARTIAL/NOT MET/N/A] | [detail] |
|
|
62
|
+
| 12 | Causal guardrails | [MET/PARTIAL/NOT MET/N/A] | [detail] |
|
|
63
|
+
| 13 | Human decision rights | [MET/PARTIAL/NOT MET/N/A] | [detail] |
|
|
64
|
+
|
|
65
|
+
Overall rigor: [STRONG | ADEQUATE | WEAK | INSUFFICIENT]
|
|
66
|
+
```
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
<!-- Full version: content/prompt-task-red-team-review.md -->
|
|
2
|
+
Act as a Senior Software Engineer running a red team diagnostic. Find every way the system can break, fail silently, corrupt data, or be exploited. Review the provided [INPUT] across four domains. Flag every finding with domain, criterion, file location, severity, concrete production failure scenario, and fix. For non-web codebases (CLI tools, libraries, data pipelines), adapt criteria to the relevant attack surface and build system; report N/A where criteria genuinely do not apply.
|
|
3
|
+
|
|
4
|
+
## Domain 1: Logic & Correctness
|
|
5
|
+
|
|
6
|
+
Targets edge cases in internal logic; for external input validation see 2.4.
|
|
7
|
+
|
|
8
|
+
### 1.1 Boundary Conditions & Edge Cases
|
|
9
|
+
- Flag numeric ops not handling: zero, negative, overflow/underflow, NaN, Infinity.
|
|
10
|
+
- Flag collection ops not handling: empty, single-element, at-capacity.
|
|
11
|
+
- Flag string ops not handling: empty, whitespace-only, Unicode edge cases (ZWJ, RTL, emoji), exceeding length.
|
|
12
|
+
- Flag date/time ops not handling: timezone conversion, DST, leap years/seconds, epoch boundaries.
|
|
13
|
+
|
|
14
|
+
### 1.2 State & Data Integrity
|
|
15
|
+
- Flag state machines with unvalidated transitions or unreachable/inescapable states.
|
|
16
|
+
- Flag read-modify-write on shared data without lock/transaction/atomic (race conditions).
|
|
17
|
+
- Flag partial mutation before possible failure without rollback (inconsistent state).
|
|
18
|
+
- Flag caches servable stale after source-of-truth change without invalidation/TTL.
|
|
19
|
+
|
|
20
|
+
### 1.3 Comparison & Equality
|
|
21
|
+
- Flag float equality (`==`/`===`) — require epsilon comparison.
|
|
22
|
+
- Flag sort/compare not handling nulls, undefined, mixed types.
|
|
23
|
+
- Flag case-sensitive comparison on user identifiers where case-insensitive is intent.
|
|
24
|
+
- Flag locale-dependent string ops on multi-locale data.
|
|
25
|
+
|
|
26
|
+
### 1.4 Resource & Lifecycle
|
|
27
|
+
- Flag resources (files, connections, sockets) not guaranteed to close in all paths (including exceptions).
|
|
28
|
+
- Flag event listeners/timers registered but never unregistered (memory leaks).
|
|
29
|
+
- Flag retry logic without max attempts or backoff (cascade failures).
|
|
30
|
+
- Flag main thread/event loop blocking (>50ms UI, >100ms server).
|
|
31
|
+
|
|
32
|
+
## Domain 2: Failure Modes & Reliability
|
|
33
|
+
|
|
34
|
+
### 2.1 Error Propagation
|
|
35
|
+
- Flag silent error swallowing (empty catch, log-only without re-throw/error return).
|
|
36
|
+
- Flag broad exception catches masking unrelated bugs.
|
|
37
|
+
- Flag unhandled async rejections (promises, futures).
|
|
38
|
+
- Flag functions returning "success" on failure paths — callers proceed with bad data.
|
|
39
|
+
|
|
40
|
+
### 2.2 Dependency Failures
|
|
41
|
+
- Flag external calls (HTTP, DB, API, filesystem) with **no timeout** — causes indefinite hangs.
|
|
42
|
+
- Flag external service integrations with **no resilience mechanism** (retry with backoff, circuit breaker, fallback, or timeout) at either the call site or client/middleware level — single dependency cascades to total failure.
|
|
43
|
+
- Flag assumptions of always-available network or always-successful disk writes.
|
|
44
|
+
|
|
45
|
+
### 2.3 Concurrency & Ordering
|
|
46
|
+
- Flag operations depending on concurrent task execution order without synchronization.
|
|
47
|
+
- Flag event/queue processing without idempotency (at-least-once requires dedup).
|
|
48
|
+
- Flag check-then-act without atomicity — Time-of-Check-to-Time-of-Use (TOCTOU).
|
|
49
|
+
- Flag shared counters/balances outside atomic operations.
|
|
50
|
+
|
|
51
|
+
### 2.4 Data Validation at Boundaries
|
|
52
|
+
|
|
53
|
+
Targets trust boundaries where external data enters the system; for internal logic edge cases see 1.1.
|
|
54
|
+
|
|
55
|
+
- Flag external input used without type checking and range validation.
|
|
56
|
+
- Flag deserialization of external data without malformed-input handling.
|
|
57
|
+
- Flag inter-service communication trusting schema without validation.
|
|
58
|
+
- Flag DB query results assumed non-null/non-empty without checks.
|
|
59
|
+
|
|
60
|
+
## Domain 3: Security & Attack Surface
|
|
61
|
+
|
|
62
|
+
### 3.1 Injection Flaws
|
|
63
|
+
- Flag SQL via string concatenation — require parameterized queries.
|
|
64
|
+
- Flag OS command execution with user input — require argument arrays/allowlisting.
|
|
65
|
+
- Flag unescaped user input in HTML — verify auto-escaping, flag bypasses (`dangerouslySetInnerHTML`, `| safe`, `{!! !!}`, `v-html`).
|
|
66
|
+
- Flag `eval`/`Function()` on user-derived data.
|
|
67
|
+
|
|
68
|
+
### 3.2 Authentication & Authorization
|
|
69
|
+
- Flag user enumeration via differing auth error messages ("user not found" vs "wrong password").
|
|
70
|
+
- Flag session tokens or JWTs in `localStorage` (XSS-accessible). Verify `httpOnly`/`secure`/`SameSite` cookies.
|
|
71
|
+
- Flag endpoints performing sensitive operations without server-side authorization — client-side-only auth is no auth.
|
|
72
|
+
- Flag insecure direct object references (IDOR): ID parameter changes granting cross-user access without ownership check.
|
|
73
|
+
|
|
74
|
+
### 3.3 Data Exposure
|
|
75
|
+
- Flag stack traces, schema, paths, versions in client errors.
|
|
76
|
+
- Flag sensitive data in logs (passwords, tokens, PII).
|
|
77
|
+
- Flag over-fetching exposing admin fields, internal IDs, or other users' data.
|
|
78
|
+
- Verify HTTPS. Flag CORS wildcard on auth endpoints.
|
|
79
|
+
|
|
80
|
+
### 3.4 AI/LLM Integration *(skip if no AI components)*
|
|
81
|
+
- Flag user input in system prompts without structural separation (prompt injection).
|
|
82
|
+
- Flag unsanitized RAG content in prompts (indirect injection).
|
|
83
|
+
- Flag destructive LLM-callable tools without user confirmation.
|
|
84
|
+
- Flag LLM output used in HTML/queries/commands without sanitization — treat as untrusted.
|
|
85
|
+
- Flag agentic systems without iteration limits, cost caps, human-in-the-loop.
|
|
86
|
+
|
|
87
|
+
## Domain 4: CI/CD & Deployment Safety
|
|
88
|
+
|
|
89
|
+
### 4.1 Pipeline Injection & Supply Chain
|
|
90
|
+
- Flag actions pinned by **mutable tag** — require **commit SHA**. Flag `${{ }}` interpolation of user-controlled input in `run:` — require `env:`. Flag `pull_request_target` + PR head checkout. Flag `curl | bash` and installs without lockfiles.
|
|
91
|
+
|
|
92
|
+
### 4.2 Secret & Permission Hygiene
|
|
93
|
+
- Flag secrets in outputs/logs. Flag secrets accessible during untrusted input processing. Verify least-privilege `permissions:`. Flag self-hosted runners on public repos.
|
|
94
|
+
|
|
95
|
+
### 4.3 Deployment Safety
|
|
96
|
+
- Flag deploys with no rollback. Flag migrations that DROP columns, rename columns, add NOT NULL without defaults, or change column types (likely not backwards-compatible). Flag deploys without health checks. Flag undocumented staging/prod config differences.
|
|
97
|
+
|
|
98
|
+
### 4.4 Test & Gating Gaps
|
|
99
|
+
- Check for SAST/DAST/SCA/secret scanning as **blocking gates**. Flag gates only on default branch. Flag test suites passable with zero tests. Flag deploys proceeding on skipped/cancelled tests.
|
|
100
|
+
|
|
101
|
+
## Output Format
|
|
102
|
+
|
|
103
|
+
Per domain:
|
|
104
|
+
```
|
|
105
|
+
## Domain N: [Name]
|
|
106
|
+
Status: PASS | FAIL | PARTIAL
|
|
107
|
+
### Findings
|
|
108
|
+
[RED-N.M] [CRITICAL|HIGH|MEDIUM|LOW] — [file:line]
|
|
109
|
+
Finding: [Bug, failure mode, or vulnerability]
|
|
110
|
+
Scenario: [How this manifests in production]
|
|
111
|
+
Fix: [Actionable remediation]
|
|
112
|
+
### Passes
|
|
113
|
+
- [What was correct]
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
Severity: CRITICAL = data corruption/loss/breach/total failure. HIGH = significant incorrect behavior under common conditions. MEDIUM = edge-case bugs or missing resilience. LOW = minor gaps, low probability.
|
|
117
|
+
|
|
118
|
+
Conclude with:
|
|
119
|
+
```
|
|
120
|
+
## Summary
|
|
121
|
+
- Domain 1 (Logic): [PASS|FAIL|PARTIAL]
|
|
122
|
+
- Domain 2 (Reliability): [PASS|FAIL|PARTIAL]
|
|
123
|
+
- Domain 3 (Security): [PASS|FAIL|PARTIAL]
|
|
124
|
+
- Domain 4 (CI/CD): [PASS|FAIL|PARTIAL]
|
|
125
|
+
Overall: [SOLID | NEEDS_HARDENING | FRAGILE]
|
|
126
|
+
Top 3 Critical Findings: [list]
|
|
127
|
+
Highest-Risk Area: [domain and why]
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
If no findings in a domain, mark PASS with a brief note on what was correct. Do not fabricate findings.
|
|
131
|
+
|
|
132
|
+
[INPUT]:
|
|
133
|
+
{provide_code_config_or_architecture_here}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Research Codebase
|
|
2
|
+
|
|
3
|
+
Document and explain the codebase as it exists today.
|
|
4
|
+
|
|
5
|
+
## Core Rule
|
|
6
|
+
|
|
7
|
+
You are a documentarian, not an evaluator.
|
|
8
|
+
|
|
9
|
+
## Procedure
|
|
10
|
+
|
|
11
|
+
1. Understand the research question and clarify the focus if needed.
|
|
12
|
+
2. Decompose the question into searchable components.
|
|
13
|
+
3. Use `references/search-patterns.md` for search strategy and preferred commands.
|
|
14
|
+
4. Read the identified files completely.
|
|
15
|
+
5. Generate the report using `references/report-template.md`.
|
|
16
|
+
|
|
17
|
+
## Rules
|
|
18
|
+
|
|
19
|
+
- Describe what exists, where it exists, and how it works.
|
|
20
|
+
- Provide file references for claims.
|
|
21
|
+
- Show relationships between components.
|
|
22
|
+
- Do not recommend improvements or refactors.
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
```markdown
|
|
2
|
+
# Research: [Topic]
|
|
3
|
+
|
|
4
|
+
Date: [ISO date]
|
|
5
|
+
Question: [Original research question]
|
|
6
|
+
|
|
7
|
+
## Summary
|
|
8
|
+
|
|
9
|
+
[2-3 paragraph high-level overview]
|
|
10
|
+
|
|
11
|
+
## Architecture Overview
|
|
12
|
+
|
|
13
|
+
[Describe the overall architecture]
|
|
14
|
+
|
|
15
|
+
## Key Components
|
|
16
|
+
|
|
17
|
+
### Component 1: [Name]
|
|
18
|
+
|
|
19
|
+
Location: `path/to/file.ext:123`
|
|
20
|
+
Purpose: [What it does]
|
|
21
|
+
Used by: [What depends on this]
|
|
22
|
+
Depends on: [What this depends on]
|
|
23
|
+
|
|
24
|
+
How it works:
|
|
25
|
+
[Step-by-step explanation]
|
|
26
|
+
|
|
27
|
+
Key methods or functions:
|
|
28
|
+
- `functionName()` (line 123): [What it does]
|
|
29
|
+
|
|
30
|
+
## Data Flow
|
|
31
|
+
|
|
32
|
+
1. [Step 1]
|
|
33
|
+
2. [Step 2]
|
|
34
|
+
3. [Step 3]
|
|
35
|
+
|
|
36
|
+
File references:
|
|
37
|
+
- Step 1: `path/to/file.ext:123`
|
|
38
|
+
- Step 2: `path/to/file.ext:456`
|
|
39
|
+
|
|
40
|
+
## Patterns and Conventions
|
|
41
|
+
|
|
42
|
+
- [Pattern]: [Purpose and evidence]
|
|
43
|
+
|
|
44
|
+
## Configuration
|
|
45
|
+
|
|
46
|
+
- Env vars: [If relevant]
|
|
47
|
+
- Config files: [If relevant]
|
|
48
|
+
|
|
49
|
+
## Error Handling
|
|
50
|
+
|
|
51
|
+
- Error types: [If relevant]
|
|
52
|
+
- Error handlers: [If relevant]
|
|
53
|
+
|
|
54
|
+
## Testing
|
|
55
|
+
|
|
56
|
+
- Test files: [If relevant]
|
|
57
|
+
- Coverage or patterns: [If determinable]
|
|
58
|
+
|
|
59
|
+
## Dependencies
|
|
60
|
+
|
|
61
|
+
- External libraries: [If relevant]
|
|
62
|
+
- Internal dependencies: [If relevant]
|
|
63
|
+
|
|
64
|
+
## Entry Points
|
|
65
|
+
|
|
66
|
+
1. `path/to/file.ext:123` - [Why it matters]
|
|
67
|
+
|
|
68
|
+
## Related Documentation
|
|
69
|
+
|
|
70
|
+
- [Doc path or README section]
|
|
71
|
+
|
|
72
|
+
## Open Questions
|
|
73
|
+
|
|
74
|
+
- [ ] [Anything still unclear]
|
|
75
|
+
```
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
## Research Search Patterns
|
|
2
|
+
|
|
3
|
+
Use fast search tools first.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
# Find auth-related files
|
|
7
|
+
rg --files | rg "auth"
|
|
8
|
+
|
|
9
|
+
# Search for authentication patterns
|
|
10
|
+
rg -n "authenticate" .
|
|
11
|
+
rg -n "login" .
|
|
12
|
+
|
|
13
|
+
# Look for middleware or hooks
|
|
14
|
+
rg -n "middleware" .
|
|
15
|
+
rg -n "useAuth" .
|
|
16
|
+
|
|
17
|
+
# Find configuration
|
|
18
|
+
rg -n "auth" config .env.example
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Research questions usually break down into:
|
|
22
|
+
- Where the logic lives
|
|
23
|
+
- What entry points exist
|
|
24
|
+
- How state is managed
|
|
25
|
+
- Where validation happens
|
|
26
|
+
- How errors are handled
|
|
27
|
+
- What the end-to-end flow looks like
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# Research Documentation Architecture
|
|
2
|
+
|
|
3
|
+
Audit the existing documentation or plan a new suite using the Unified Frameworks for Technical Information Architecture.
|
|
4
|
+
|
|
5
|
+
## CRITICAL RULES
|
|
6
|
+
|
|
7
|
+
1. ✅ **DO:** Categorize every document into exactly one Diátaxis quadrant.
|
|
8
|
+
2. ✅ **DO:** Identify "Frankenbooks" (documents with mixed intent/quadrants).
|
|
9
|
+
3. ✅ **DO:** Map the "Snowflake" progression from Core Assertion to granular topics.
|
|
10
|
+
4. ✅ **DO:** Verify EPPO compliance (Does each page establish its own context?).
|
|
11
|
+
5. ❌ **DO NOT:** Start writing content yet; focus on architecture and gaps.
|
|
12
|
+
6. ❌ **DO NOT:** Suggest stylistic changes (focus on structural integrity).
|
|
13
|
+
|
|
14
|
+
## Process
|
|
15
|
+
|
|
16
|
+
### Step 1: Define the Scope
|
|
17
|
+
|
|
18
|
+
[User will provide a path to a documentation directory or a project description.]
|
|
19
|
+
- Identify the primary audience (Novice vs. Expert).
|
|
20
|
+
- State the "Core Assertion" (The single-sentence value proposition).
|
|
21
|
+
- **Legacy Conflict Resolution:** If existing documentation contains multiple, conflicting "hooks," identify the most impactful one or propose a synthesis for the new architecture.
|
|
22
|
+
|
|
23
|
+
### Step 2: Audit Existing Content (if applicable)
|
|
24
|
+
|
|
25
|
+
For each file in the directory, determine:
|
|
26
|
+
- **Quadrant:** (Tutorial | How-to | Reference | Explanation).
|
|
27
|
+
- **EPPO Status:** (Pass/Fail) Does it have standalone utility and context?
|
|
28
|
+
- **Cognitive Load:** Are there "walls of words" or missing labels?
|
|
29
|
+
|
|
30
|
+
### Step 3: Map the Snowflake Outline
|
|
31
|
+
|
|
32
|
+
Expand the Core Assertion into a structural map:
|
|
33
|
+
1. **Core Assertion:** [1 sentence]
|
|
34
|
+
2. **Macro-Expansion:** [1 paragraph user journey]
|
|
35
|
+
3. **Component List:** [The "characters" of the system]
|
|
36
|
+
4. **Topic Matrix:** A list of proposed EPPO topics categorized by quadrant.
|
|
37
|
+
|
|
38
|
+
### Step 4: Identify Gaps and Friction
|
|
39
|
+
|
|
40
|
+
- **Quadrant Imbalance:** e.g., "Too much reference, not enough tutorials."
|
|
41
|
+
- **Structural Plot-holes:** Where does the user journey break?
|
|
42
|
+
- **AI-Readiness Gaps:** Missing `llms.txt`, poor semantic labeling.
|
|
43
|
+
|
|
44
|
+
### Step 5: Final Research Report
|
|
45
|
+
|
|
46
|
+
Output the audit/plan using the following template:
|
|
47
|
+
|
|
48
|
+
```markdown
|
|
49
|
+
# Documentation Research: [Project Name]
|
|
50
|
+
|
|
51
|
+
## 1. Executive Summary & Core Assertion
|
|
52
|
+
**Core Assertion:** [The one-sentence hook]
|
|
53
|
+
**Status:** [Summary of current architecture health]
|
|
54
|
+
|
|
55
|
+
## 2. Diátaxis Matrix
|
|
56
|
+
| Quadrant | Existing Topics | Proposed/Missing Topics |
|
|
57
|
+
| :--- | :--- | :--- |
|
|
58
|
+
| **Tutorial** | | |
|
|
59
|
+
| **How-to** | | |
|
|
60
|
+
| **Reference** | | |
|
|
61
|
+
| **Explanation** | | |
|
|
62
|
+
|
|
63
|
+
## 3. Snowflake Structural Map
|
|
64
|
+
- **Macro-Journey:** [Description]
|
|
65
|
+
- **Key Components:** [List]
|
|
66
|
+
|
|
67
|
+
## 4. EPPO & Cognitive Audit
|
|
68
|
+
- **Frankenbooks Found:** [List of files with mixed intent]
|
|
69
|
+
- **Context Gaps:** [Topics needing better orientation]
|
|
70
|
+
|
|
71
|
+
## 5. AI-Readiness Assessment
|
|
72
|
+
- [ ] `llms.txt` present?
|
|
73
|
+
- [ ] Explicit semantic labeling for RAG?
|
|
74
|
+
- [ ] MCP endpoints identified?
|
|
75
|
+
|
|
76
|
+
## 6. Recommended Next Steps
|
|
77
|
+
1. [Actionable structural change]
|
|
78
|
+
2. [Actionable topic creation]
|
|
79
|
+
```
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
<!-- skill: research-review, version: 1.2.0, status: verified -->
|
|
2
|
+
# Iterative Research Review
|
|
3
|
+
|
|
4
|
+
Thoroughly review research documents for accuracy, completeness, and actionability using the Rule of 5 iterative refinement process.
|
|
5
|
+
|
|
6
|
+
## Role
|
|
7
|
+
You are a Senior Research Scientist. Your goal is to validate the integrity of findings, ensure all research questions are answered, and confirm that conclusions are supported by empirical evidence. You protect the project from making decisions based on outdated, inaccurate, or incomplete information.
|
|
8
|
+
|
|
9
|
+
## Procedure
|
|
10
|
+
|
|
11
|
+
1. **Research Identification:**
|
|
12
|
+
* Identify the research document to review. If none is provided, list available research files.
|
|
13
|
+
* Read the document completely to understand the problem statement, methodology, and conclusions.
|
|
14
|
+
|
|
15
|
+
2. **Iterative Analysis (Rule of 5):**
|
|
16
|
+
Perform up to 5 passes, each with a specific focus. After each pass (starting with Pass 2), perform a **Convergence Check**.
|
|
17
|
+
* **Pass 1: Accuracy & Sources** — Evidence-backed claims, source credibility/recency, and factual correctness of technical details.
|
|
18
|
+
* **Pass 2: Completeness & Scope** — Unanswered research questions, gaps in analysis, and appropriate depth for the topic.
|
|
19
|
+
* **Pass 3: Clarity & Structure** — Logical flow, clear definitions of terms, and consistent terminology.
|
|
20
|
+
* **Pass 4: Actionability & Conclusions** — Clear takeaways, trade-offs articulated, and practical applicability to the project.
|
|
21
|
+
* **Pass 5: Integration & Context** — Alignment with existing research, specs, and established project decisions.
|
|
22
|
+
|
|
23
|
+
3. **Convergence Check:**
|
|
24
|
+
* Stop and report if **CONVERGED**: No new CRITICAL issues found AND new issue rate is <10% compared to the previous pass.
|
|
25
|
+
* Otherwise, continue to the next pass.
|
|
26
|
+
|
|
27
|
+
4. **Verification (CRITICAL):**
|
|
28
|
+
* **DO NOT** take research claims at face value. Use `read_file` or `grep_search` to cross-check any code references or architectural claims against the actual codebase.
|
|
29
|
+
* Verify that referenced library versions or APIs are not deprecated or outdated.
|
|
30
|
+
|
|
31
|
+
5. **Final Synthesis:**
|
|
32
|
+
* Produce a Final Report with a clear **Verdict** (READY | NEEDS_REVISION | NEEDS_MORE_RESEARCH) and a **Quality Assessment**.
|
|
33
|
+
|
|
34
|
+
## Rules
|
|
35
|
+
- **Verify Every Claim:** If a research document says "File X does Y", you must verify it before approving the research.
|
|
36
|
+
- **Actionable Takeaways:** Research without a "next step" or recommendation is a HIGH-severity failure.
|
|
37
|
+
- **Cite the Code:** All technical findings must reference specific files and, where possible, line ranges.
|
|
38
|
+
- **Stop Early:** Do not force 5 stages if convergence is reached sooner.
|
|
39
|
+
|
|
40
|
+
## References
|
|
41
|
+
- **Templates:** Use `references/templates.md` for the exact output format of each pass and the final report.
|
|
42
|
+
- **Criteria:** See `references/criteria.md` for detailed convergence rules and issue severity definitions.
|
|
@@ -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?
|