craftassay 0.1.0 → 0.1.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
CHANGED
|
@@ -18,10 +18,11 @@ The report is an assessment, not a certification.
|
|
|
18
18
|
## Review, then decide
|
|
19
19
|
|
|
20
20
|
Submit a tool, a site, a skill, a spec, or a portfolio. The agent
|
|
21
|
-
writes `report.md` plus a scorecard,
|
|
22
|
-
skill does not edit the source.
|
|
21
|
+
writes a dated run folder with `report.md` plus a scorecard,
|
|
22
|
+
findings, and coverage. The skill does not edit the source.
|
|
23
23
|
|
|
24
24
|
A later pass with the earlier report attached becomes a comparison.
|
|
25
|
+
It does not overwrite the earlier folder.
|
|
25
26
|
|
|
26
27
|
## Install
|
|
27
28
|
|
|
@@ -29,19 +30,21 @@ A later pass with the earlier report attached becomes a comparison.
|
|
|
29
30
|
pnpm add -D craftassay
|
|
30
31
|
```
|
|
31
32
|
|
|
32
|
-
Copy `node_modules/craftassay/skills/craftassay
|
|
33
|
+
Copy `node_modules/craftassay/skills/craftassay/` to
|
|
33
34
|
`.cursor/skills/craftassay`. Or skip npm and
|
|
34
|
-
[install the skill](https://craftassay.dev/docs/
|
|
35
|
+
[install the skill](https://craftassay.dev/docs/install) as a folder.
|
|
35
36
|
|
|
36
|
-
|
|
37
|
+
The package does not run an automatic scanner. The reviewing agent
|
|
38
|
+
may inspect project files you point it at. v1 has no CLI.
|
|
37
39
|
|
|
38
|
-
##
|
|
40
|
+
## CraftAssay and Cold-eye
|
|
39
41
|
|
|
40
42
|
[Cold-eye](https://coldeye.dev) reviews readiness for a claimed
|
|
41
43
|
first-use path. CraftAssay reviews usefulness, clarity, quality, and
|
|
42
|
-
presentation
|
|
43
|
-
|
|
44
|
-
|
|
44
|
+
presentation, including first-use friction that affects those
|
|
45
|
+
scores. It does not issue a release-readiness verdict.
|
|
46
|
+
[Smell Check](https://smellcheck.dev) reviews unearned language.
|
|
47
|
+
[Detangler](https://detangler.dev) reviews what editing tangled.
|
|
45
48
|
|
|
46
49
|
## Development
|
|
47
50
|
|
package/package.json
CHANGED
|
@@ -3,7 +3,7 @@ name: craftassay
|
|
|
3
3
|
description: >-
|
|
4
4
|
Evidence-backed review of usefulness, clarity, quality, and
|
|
5
5
|
presentation. Review or compare a tool, site, skill, spec, or
|
|
6
|
-
portfolio.
|
|
6
|
+
portfolio. First-use findings stay. Not a readiness verdict.
|
|
7
7
|
---
|
|
8
8
|
|
|
9
9
|
# CraftAssay
|
|
@@ -11,8 +11,16 @@ description: >-
|
|
|
11
11
|
You write the review. The subject does not change.
|
|
12
12
|
|
|
13
13
|
CraftAssay asks how useful, clear, credible, and well-presented the
|
|
14
|
-
work is, and what should improve.
|
|
15
|
-
|
|
14
|
+
work is, and what should improve. Inspect the discovery-to-first-use
|
|
15
|
+
path when it bears on those seven dimensions. Report missing
|
|
16
|
+
prerequisites, unusable onboarding, and other first-use friction
|
|
17
|
+
when the evidence supports it.
|
|
18
|
+
|
|
19
|
+
Cold-eye asks whether a newcomer can use what is presented as ready.
|
|
20
|
+
Do not issue a release-readiness verdict. That conclusion is
|
|
21
|
+
Cold-eye's. The two reviews may share evidence. The distinction
|
|
22
|
+
governs the conclusion, not which facts you may record.
|
|
23
|
+
|
|
16
24
|
You may recommend a Cold-eye pass, or import a supplied Cold-eye
|
|
17
25
|
review as a source. Preserve its version, scope, date, and evidence.
|
|
18
26
|
|
|
@@ -27,23 +35,21 @@ rubric v1.0. If a full spec file is in the repo
|
|
|
27
35
|
(`craftassay-review-spec-v1.1.md`), read it when a rule here is
|
|
28
36
|
thin. These reference files win for the report shape you emit.
|
|
29
37
|
|
|
30
|
-
##
|
|
38
|
+
## Review workflow
|
|
31
39
|
|
|
32
|
-
1. Locate the subject (a project, site, skill, spec, portfolio,
|
|
33
|
-
what they pasted). If none, ask. Establish the intended
|
|
34
|
-
and included surfaces before scoring.
|
|
35
|
-
2.
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
A paste with no file → `subject.craftassay/` in the working
|
|
39
|
-
directory.
|
|
40
|
+
1. Locate the subject (a project, site, skill, spec, portfolio, a
|
|
41
|
+
URL, or what they pasted). If none, ask. Establish the intended
|
|
42
|
+
audience and included surfaces before scoring.
|
|
43
|
+
2. Choose a **new run folder**. Follow `references/output.md`.
|
|
44
|
+
Never write into a folder that already has `report.md`. Never
|
|
45
|
+
overwrite a supplied baseline.
|
|
40
46
|
3. Follow `references/coverage.md`. Record what you inspected.
|
|
41
47
|
Stop once the evidence is enough for the stated depth.
|
|
42
48
|
4. Write the deliverables using `references/report.md`.
|
|
43
|
-
Create the folder if needed.
|
|
44
|
-
5. If they attached an earlier CraftAssay review,
|
|
45
|
-
`references/comparison.md`. Title that
|
|
46
|
-
`CraftAssay Comparison: <subject>`.
|
|
49
|
+
Create the run folder if needed.
|
|
50
|
+
5. If they attached an earlier CraftAssay review, or you found one
|
|
51
|
+
locally, also follow `references/comparison.md`. Title that
|
|
52
|
+
report `CraftAssay Comparison: <subject>`.
|
|
47
53
|
6. Hand over the report. Stop. Do not edit the subject. Do not
|
|
48
54
|
write implementation specs unless they asked in a separate
|
|
49
55
|
instruction.
|
|
@@ -83,8 +89,10 @@ Do not lower a score only because confidence is lower.
|
|
|
83
89
|
Read `references/findings.md` before you emit.
|
|
84
90
|
|
|
85
91
|
Every material finding needs an id, a classification, a surface,
|
|
86
|
-
evidence, a consequence, a priority, and
|
|
87
|
-
|
|
92
|
+
evidence, a consequence, a priority, and either the smallest
|
|
93
|
+
useful correction or a specific verification step. Drop vague
|
|
94
|
+
criticism. Keep a concrete unresolved question when the next
|
|
95
|
+
check is clear. That is what `verify-first` is for.
|
|
88
96
|
|
|
89
97
|
## Rules
|
|
90
98
|
|
|
@@ -97,8 +105,9 @@ change. No action → drop it.
|
|
|
97
105
|
|
|
98
106
|
## When to read the reference files
|
|
99
107
|
|
|
108
|
+
- `references/output.md` — before you choose a folder.
|
|
100
109
|
- `references/report.md` — before you write `report.md`.
|
|
101
110
|
- `references/dimensions.md` — before you assign scores.
|
|
102
111
|
- `references/findings.md` — before you emit a finding.
|
|
103
112
|
- `references/coverage.md` — before you claim what was checked.
|
|
104
|
-
- `references/comparison.md` — when a baseline review
|
|
113
|
+
- `references/comparison.md` — when a baseline review exists.
|
|
@@ -1,9 +1,12 @@
|
|
|
1
1
|
# Comparison
|
|
2
2
|
|
|
3
|
-
Use this file
|
|
3
|
+
Use this file when an earlier CraftAssay review is supplied or
|
|
4
|
+
found locally. Follow `output.md`. Write the comparison into a
|
|
5
|
+
**new** run folder. Do not overwrite the baseline.
|
|
4
6
|
|
|
5
7
|
1. Retain the original report, date, identities, scores, coverage,
|
|
6
|
-
and findings. Do not silently rewrite earlier ratings.
|
|
8
|
+
and findings. Do not silently rewrite earlier ratings. Do not
|
|
9
|
+
write into the baseline directory.
|
|
7
10
|
2. Inspect current sources and draft the new rationale before
|
|
8
11
|
focusing on numerical deltas.
|
|
9
12
|
3. Record additions, removals, renames, and changed boundaries.
|
|
@@ -14,7 +14,7 @@ subject_version: null
|
|
|
14
14
|
confidence: "high | medium | low"
|
|
15
15
|
consequence: "Why this matters to the intended user"
|
|
16
16
|
priority: "P1 | P2 | P3"
|
|
17
|
-
recommended_change: "Smallest
|
|
17
|
+
recommended_change: "Smallest useful correction, or a specific next check"
|
|
18
18
|
acceptance_criteria: []
|
|
19
19
|
verification_needed: "Focused next check, if any"
|
|
20
20
|
status: "open | resolved | partially-resolved | unchanged | regressed | not-rechecked | superseded | withdrawn"
|
|
@@ -30,8 +30,9 @@ prior_finding_id: null
|
|
|
30
30
|
- **claim-risk** — wording is broader than the presented evidence
|
|
31
31
|
- **presentation-judgment** — editorial or visual assessment on
|
|
32
32
|
the user's path
|
|
33
|
-
- **verify-first** — an unresolved implementation question.
|
|
34
|
-
|
|
33
|
+
- **verify-first** — an unresolved implementation question. Keep
|
|
34
|
+
it when the next check is specific. Do not drop it for lack of
|
|
35
|
+
a fix. Drop only vague criticism with no check and no correction.
|
|
35
36
|
|
|
36
37
|
## Priority
|
|
37
38
|
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Output folders
|
|
2
|
+
|
|
3
|
+
Each review run gets its own directory. Required filenames stay
|
|
4
|
+
`report.md`, `scorecard.md`, `findings.md`, and `coverage.md`
|
|
5
|
+
inside that run folder.
|
|
6
|
+
|
|
7
|
+
## Parent folder
|
|
8
|
+
|
|
9
|
+
| Subject | Parent |
|
|
10
|
+
| --- | --- |
|
|
11
|
+
| A file | `<stem>.craftassay/` next to the file. `README.md` → `README.craftassay/` |
|
|
12
|
+
| A named folder or system | `craftassay/` at that root |
|
|
13
|
+
| A URL or paste with no project directory | `subject.craftassay/` in the working directory |
|
|
14
|
+
|
|
15
|
+
## Run folder
|
|
16
|
+
|
|
17
|
+
Write to `<parent>/<YYYY-MM-DD>/`.
|
|
18
|
+
|
|
19
|
+
If that directory already exists, use `<YYYY-MM-DD>-2`, then
|
|
20
|
+
`-3`, and so on.
|
|
21
|
+
|
|
22
|
+
Never write into a directory that already contains `report.md`.
|
|
23
|
+
Never write into a supplied baseline path.
|
|
24
|
+
|
|
25
|
+
## Finding an earlier local review
|
|
26
|
+
|
|
27
|
+
1. A baseline they attached wins. Use it. Do not modify it.
|
|
28
|
+
2. Else look under the parent folder for the newest run that
|
|
29
|
+
contains `report.md`. Prefer a `CraftAssay Review:` or
|
|
30
|
+
`CraftAssay Comparison:` title.
|
|
31
|
+
3. If none exists, this is the first review.
|
|
32
|
+
|
|
33
|
+
A dated or numbered run folder is enough. No database.
|