incitaciones 0.2.0 → 0.3.1
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/README.md +57 -0
- package/content/distilled/close/SKILL.md +68 -0
- package/content/distilled/create-issues/SKILL.md +10 -0
- package/content/distilled/implement-documentation/SKILL.md +29 -0
- package/content/distilled/implement-documentation/references/anti-patterns.md +35 -0
- package/content/distilled/implement-documentation/references/diataxis-implementation.md +31 -0
- package/content/distilled/implement-documentation/references/templates.md +115 -0
- package/content/distilled/implement-documentation/references/tooling-comparison.md +46 -0
- package/content/distilled/implement-documentation/references/versioning.md +31 -0
- package/content/distilled/issue-review/SKILL.md +5 -4
- package/content/distilled/issue-review/references/pass-0-preflight.md +37 -0
- package/content/distilled/next/SKILL.md +54 -0
- package/content/distilled/park/SKILL.md +98 -0
- package/content/distilled/renew/SKILL.md +164 -0
- package/content/distilled/research-documentation/SKILL.md +29 -0
- package/content/distilled/research-documentation/references/checklist.md +58 -0
- package/content/distilled/research-documentation/references/llm-readiness.md +43 -0
- package/content/distilled/research-documentation/references/metrics.md +42 -0
- package/content/distilled/research-documentation/references/report-template.md +42 -0
- package/content/distilled/review-documentation/SKILL.md +49 -0
- package/content/distilled/review-documentation/references/ai-readiness-criteria.md +38 -0
- package/content/distilled/whisper/SKILL.md +83 -0
- package/content/distilled/whisper/references/check.md +33 -0
- package/content/distilled/whisper/references/decommission.md +53 -0
- package/content/distilled/whisper/references/init.md +103 -0
- package/content/distilled/whisper/references/link.md +70 -0
- package/content/distilled/whisper/references/status.md +49 -0
- package/content/manifest.json +458 -11
- package/package.json +2 -1
- package/pi-package/prompts/close.md +10 -0
- package/pi-package/prompts/next.md +10 -0
- package/pi-package/prompts/park.md +10 -0
- package/pi-package/prompts/renew.md +10 -0
- package/pi-package/prompts/whisper.md +10 -0
- package/pi-package/skills/close/SKILL.md +74 -0
- package/pi-package/skills/create-issues/SKILL.md +10 -0
- package/pi-package/skills/implement-documentation/SKILL.md +18 -57
- package/pi-package/skills/implement-documentation/references/anti-patterns.md +35 -0
- package/pi-package/skills/implement-documentation/references/diataxis-implementation.md +31 -0
- package/pi-package/skills/implement-documentation/references/templates.md +115 -0
- package/pi-package/skills/implement-documentation/references/tooling-comparison.md +46 -0
- package/pi-package/skills/implement-documentation/references/versioning.md +31 -0
- package/pi-package/skills/issue-review/SKILL.md +5 -4
- package/pi-package/skills/issue-review/references/pass-0-preflight.md +37 -0
- package/pi-package/skills/next/SKILL.md +60 -0
- package/pi-package/skills/park/SKILL.md +104 -0
- package/pi-package/skills/renew/SKILL.md +170 -0
- package/pi-package/skills/research-documentation/SKILL.md +19 -69
- package/pi-package/skills/research-documentation/references/checklist.md +58 -0
- package/pi-package/skills/research-documentation/references/llm-readiness.md +43 -0
- package/pi-package/skills/research-documentation/references/metrics.md +42 -0
- package/pi-package/skills/research-documentation/references/report-template.md +42 -0
- package/pi-package/skills/review-documentation/SKILL.md +45 -40
- package/pi-package/skills/review-documentation/references/ai-readiness-criteria.md +38 -0
- package/pi-package/skills/whisper/SKILL.md +89 -0
- package/pi-package/skills/whisper/references/check.md +33 -0
- package/pi-package/skills/whisper/references/decommission.md +53 -0
- package/pi-package/skills/whisper/references/init.md +103 -0
- package/pi-package/skills/whisper/references/link.md +70 -0
- package/pi-package/skills/whisper/references/status.md +49 -0
- package/scripts/generate-pi-resources.mjs +122 -0
- package/content/distilled/implement-documentation.md +0 -68
- package/content/distilled/research-documentation.md +0 -79
- package/content/distilled/review-documentation.md +0 -44
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
# Review Documentation Quality
|
|
2
|
-
|
|
3
|
-
Perform a Rule of 5 review of the documentation using the Unified Frameworks for Technical Information Architecture.
|
|
4
|
-
|
|
5
|
-
## REVIEW PROCESS
|
|
6
|
-
|
|
7
|
-
Perform 5 iterative passes, checking for convergence after each pass (starting with pass 2).
|
|
8
|
-
|
|
9
|
-
### PASS 1: Diátaxis & Intent
|
|
10
|
-
- **Goal:** Does this topic have a single, clear intent?
|
|
11
|
-
- **Checks:** Is it a Tutorial, How-to, Reference, or Explanation? Are there "leaked" intents? (e.g., too much theory in a Tutorial).
|
|
12
|
-
- **Issue Prefix:** [INTENT-001]
|
|
13
|
-
|
|
14
|
-
### PASS 2: EPPO & Standalone Utility
|
|
15
|
-
- **Goal:** Can a "foraging" reader land here and succeed?
|
|
16
|
-
- **Checks:** Are context and prerequisites established in the first two sentences? Does it rely on "previous chapter" knowledge without links?
|
|
17
|
-
- **Issue Prefix:** [EPPO-001]
|
|
18
|
-
|
|
19
|
-
### PASS 3: Cognitive Scannability (Info Mapping)
|
|
20
|
-
- **Goal:** Can the reader scan the page in <10 seconds and find the key answer?
|
|
21
|
-
- **Checks:** Are **labels** (descriptive headers) used for every 2-3 paragraphs? Are paragraphs chunked into small units? Are there tables/lists for complex data?
|
|
22
|
-
- **Issue Prefix:** [SCAN-001]
|
|
23
|
-
|
|
24
|
-
### PASS 4: Accuracy, "Whole Game" & Fail-States
|
|
25
|
-
- **Goal:** Is the content technically sound and resilient?
|
|
26
|
-
- **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)?
|
|
27
|
-
- **Issue Prefix:** [ACC-001]
|
|
28
|
-
|
|
29
|
-
### PASS 5: Excellence & AI-Readiness
|
|
30
|
-
- **Goal:** Is it production-ready and optimized for AI agents?
|
|
31
|
-
- **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?
|
|
32
|
-
- **Issue Prefix:** [EXCL-001]
|
|
33
|
-
|
|
34
|
-
## Convergence Check
|
|
35
|
-
After each pass (starting with pass 2), report:
|
|
36
|
-
- Total new issues found.
|
|
37
|
-
- Estimated "Signal-to-Noise" ratio.
|
|
38
|
-
- Convergence status: (CONVERGED | CONTINUE).
|
|
39
|
-
|
|
40
|
-
## Final Report Format
|
|
41
|
-
- **Total Issues by Severity** (Critical | High | Medium | Low).
|
|
42
|
-
- **Top 3 Findings.**
|
|
43
|
-
- **Verdict:** (Ready | Needs Revision | Needs Rework).
|
|
44
|
-
- **Rationale.**
|