incitaciones 0.12.0 → 0.13.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/content/distilled/documentation/references/review-documentation/SKILL.md +6 -3
- package/content/distilled/documentation/references/review-documentation/references/ai-readiness-criteria.md +1 -0
- package/content/manifest.json +1 -1
- package/package.json +1 -1
- package/pi-package/skills/documentation/references/review-documentation/SKILL.md +6 -3
- package/pi-package/skills/documentation/references/review-documentation/references/ai-readiness-criteria.md +1 -0
|
@@ -16,7 +16,7 @@ Goal: does this topic have a single, clear intent? Checks: is it a Tutorial, How
|
|
|
16
16
|
|
|
17
17
|
### Pass 2: EPPO & Standalone Utility
|
|
18
18
|
|
|
19
|
-
Goal: can a foraging reader land here and succeed? Checks: are context and prerequisites established in the first two sentences? Does it rely on "previous chapter" knowledge without links? Issue prefix: [EPPO-001].
|
|
19
|
+
Goal: can a foraging reader land here and succeed? Checks: are context and prerequisites established in the first two sentences? Does it rely on "previous chapter" knowledge without links? Is domain jargon defined at first use or via a glossary? (Jargon rule: `../research-documentation/references/checklist.md` and `../implement-documentation/references/anti-patterns.md` — cross-reference, do not duplicate here.) Issue prefix: [EPPO-001].
|
|
20
20
|
|
|
21
21
|
### Pass 3: Cognitive Scannability (Info Mapping)
|
|
22
22
|
|
|
@@ -24,11 +24,11 @@ Goal: can the reader scan the page in under 10 seconds and find the key answer?
|
|
|
24
24
|
|
|
25
25
|
### Pass 4: Accuracy, "Whole Game" & Fail-States
|
|
26
26
|
|
|
27
|
-
Goal: is the content technically sound and resilient? Checks: are code snippets verified? Does it show the complete result? Are common errors documented? In tutorials, is the Martini Glass pattern followed (guided context then open exploration)? Issue prefix: [ACC-001].
|
|
27
|
+
Goal: is the content technically sound and resilient? Checks: are code snippets verified? Does it show the complete result? Are common errors documented? In tutorials, is the Martini Glass pattern followed (guided context then open exploration)? If the subject is a runnable tool/API: spot-check documented claims against the artifact itself (the method statement goes in the Final Report provenance block). For entry-point pages (README / landing / quickstart): is there a quickstart reaching a first verified success in minutes (time-to-first-success; see `../research-documentation/references/metrics.md`)? Issue prefix: [ACC-001].
|
|
28
28
|
|
|
29
29
|
### Pass 5: Excellence & AI-Readiness
|
|
30
30
|
|
|
31
|
-
Goal: is it production-ready and optimized for AI agents? Checks: is there a TL;DR for LLMs? Are headers semantically unique for RAG? Is the Answer First (Pyramid Principle) in the TL;DR and first paragraph? Use `references/ai-readiness-criteria.md` for the deep AI-readiness checks (`llms.txt`, RAG chunking, dual-audience, schema sync). Issue prefix: [EXCL-001].
|
|
31
|
+
Goal: is it production-ready and optimized for AI agents? Checks: is there a TL;DR for LLMs? Are headers semantically unique for RAG? Is the Answer First (Pyramid Principle) in the TL;DR and first paragraph? Use `references/ai-readiness-criteria.md` for the deep AI-readiness checks (`llms.txt`, RAG chunking, dual-audience, schema sync). Are claims marked by status — documented / interpreted / proposed / unknown — with unverified claims not stated as fact? Issue prefix: [EXCL-001].
|
|
32
32
|
|
|
33
33
|
## Final Report
|
|
34
34
|
|
|
@@ -36,10 +36,13 @@ Goal: is it production-ready and optimized for AI agents? Checks: is there a TL;
|
|
|
36
36
|
- Top 3 Findings.
|
|
37
37
|
- Verdict: Ready, Needs Revision, or Needs Rework.
|
|
38
38
|
- Rationale.
|
|
39
|
+
- Provenance: which revision/commit of the subject was reviewed (mark UNKNOWN if unpinned — never guess) and the review method (runtime-verified vs read-only).
|
|
40
|
+
- Optional (entry-point pages: README / landing / quickstart): audience-barrier table (reader type × barriers × recommended approach).
|
|
39
41
|
|
|
40
42
|
## Rules
|
|
41
43
|
|
|
42
44
|
- Reference exact locations (file, section, paragraph).
|
|
45
|
+
- Cross-referenced criteria live in sibling mode references — do not copy them into this file; link instead.
|
|
43
46
|
- Validate issues exist; do not flag "potential" issues without evidence.
|
|
44
47
|
- The canonical theory lives in `content/research-documentation-frameworks.md`; `references/ai-readiness-criteria.md` is an operational excerpt that links back to it.
|
|
45
48
|
|
|
@@ -25,6 +25,7 @@ Deep checks for Pass 5. The basic pass (TL;DR present, headers unique, Answer Fi
|
|
|
25
25
|
- Is language precise enough for a machine? Natural-language ambiguity a human resolves from context is opaque to an agent.
|
|
26
26
|
- Are error conditions and their meanings explicit?
|
|
27
27
|
- Are capability boundaries stated (what the tool/API can and cannot do)?
|
|
28
|
+
- Are claims marked by status (documented / interpreted / proposed / unknown) rather than stated as fact when unverified?
|
|
28
29
|
|
|
29
30
|
## Schema and spec sync (reference pages)
|
|
30
31
|
|
package/content/manifest.json
CHANGED
package/package.json
CHANGED
|
@@ -16,7 +16,7 @@ Goal: does this topic have a single, clear intent? Checks: is it a Tutorial, How
|
|
|
16
16
|
|
|
17
17
|
### Pass 2: EPPO & Standalone Utility
|
|
18
18
|
|
|
19
|
-
Goal: can a foraging reader land here and succeed? Checks: are context and prerequisites established in the first two sentences? Does it rely on "previous chapter" knowledge without links? Issue prefix: [EPPO-001].
|
|
19
|
+
Goal: can a foraging reader land here and succeed? Checks: are context and prerequisites established in the first two sentences? Does it rely on "previous chapter" knowledge without links? Is domain jargon defined at first use or via a glossary? (Jargon rule: `../research-documentation/references/checklist.md` and `../implement-documentation/references/anti-patterns.md` — cross-reference, do not duplicate here.) Issue prefix: [EPPO-001].
|
|
20
20
|
|
|
21
21
|
### Pass 3: Cognitive Scannability (Info Mapping)
|
|
22
22
|
|
|
@@ -24,11 +24,11 @@ Goal: can the reader scan the page in under 10 seconds and find the key answer?
|
|
|
24
24
|
|
|
25
25
|
### Pass 4: Accuracy, "Whole Game" & Fail-States
|
|
26
26
|
|
|
27
|
-
Goal: is the content technically sound and resilient? Checks: are code snippets verified? Does it show the complete result? Are common errors documented? In tutorials, is the Martini Glass pattern followed (guided context then open exploration)? Issue prefix: [ACC-001].
|
|
27
|
+
Goal: is the content technically sound and resilient? Checks: are code snippets verified? Does it show the complete result? Are common errors documented? In tutorials, is the Martini Glass pattern followed (guided context then open exploration)? If the subject is a runnable tool/API: spot-check documented claims against the artifact itself (the method statement goes in the Final Report provenance block). For entry-point pages (README / landing / quickstart): is there a quickstart reaching a first verified success in minutes (time-to-first-success; see `../research-documentation/references/metrics.md`)? Issue prefix: [ACC-001].
|
|
28
28
|
|
|
29
29
|
### Pass 5: Excellence & AI-Readiness
|
|
30
30
|
|
|
31
|
-
Goal: is it production-ready and optimized for AI agents? Checks: is there a TL;DR for LLMs? Are headers semantically unique for RAG? Is the Answer First (Pyramid Principle) in the TL;DR and first paragraph? Use `references/ai-readiness-criteria.md` for the deep AI-readiness checks (`llms.txt`, RAG chunking, dual-audience, schema sync). Issue prefix: [EXCL-001].
|
|
31
|
+
Goal: is it production-ready and optimized for AI agents? Checks: is there a TL;DR for LLMs? Are headers semantically unique for RAG? Is the Answer First (Pyramid Principle) in the TL;DR and first paragraph? Use `references/ai-readiness-criteria.md` for the deep AI-readiness checks (`llms.txt`, RAG chunking, dual-audience, schema sync). Are claims marked by status — documented / interpreted / proposed / unknown — with unverified claims not stated as fact? Issue prefix: [EXCL-001].
|
|
32
32
|
|
|
33
33
|
## Final Report
|
|
34
34
|
|
|
@@ -36,10 +36,13 @@ Goal: is it production-ready and optimized for AI agents? Checks: is there a TL;
|
|
|
36
36
|
- Top 3 Findings.
|
|
37
37
|
- Verdict: Ready, Needs Revision, or Needs Rework.
|
|
38
38
|
- Rationale.
|
|
39
|
+
- Provenance: which revision/commit of the subject was reviewed (mark UNKNOWN if unpinned — never guess) and the review method (runtime-verified vs read-only).
|
|
40
|
+
- Optional (entry-point pages: README / landing / quickstart): audience-barrier table (reader type × barriers × recommended approach).
|
|
39
41
|
|
|
40
42
|
## Rules
|
|
41
43
|
|
|
42
44
|
- Reference exact locations (file, section, paragraph).
|
|
45
|
+
- Cross-referenced criteria live in sibling mode references — do not copy them into this file; link instead.
|
|
43
46
|
- Validate issues exist; do not flag "potential" issues without evidence.
|
|
44
47
|
- The canonical theory lives in `content/research-documentation-frameworks.md`; `references/ai-readiness-criteria.md` is an operational excerpt that links back to it.
|
|
45
48
|
|
|
@@ -25,6 +25,7 @@ Deep checks for Pass 5. The basic pass (TL;DR present, headers unique, Answer Fi
|
|
|
25
25
|
- Is language precise enough for a machine? Natural-language ambiguity a human resolves from context is opaque to an agent.
|
|
26
26
|
- Are error conditions and their meanings explicit?
|
|
27
27
|
- Are capability boundaries stated (what the tool/API can and cannot do)?
|
|
28
|
+
- Are claims marked by status (documented / interpreted / proposed / unknown) rather than stated as fact when unverified?
|
|
28
29
|
|
|
29
30
|
## Schema and spec sync (reference pages)
|
|
30
31
|
|