Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .claude-plugin/marketplace.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"skills": [
"./skills/reverse-engineering-saas"
],
"version": "0.3.1"
"version": "0.4.0"
}
]
}
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Changelog

## 0.4.0 (2026-10-17)

- `REPORT.html` redesigned as a UX study a person can read and navigate: IBM Plex type, a light and a dark theme with a toggle, a one-line answer with the key findings, stat tiles, section chips, and screenshots in framed figures that enlarge on click.
- Screens: anatomy screenshot beside a numbered legend linked to the components, a gallery of the screen's evidence, the states seen and the states not reached.
- Components: one card per component with a screenshot, variants and states as pills (solid when seen, dashed when not), and behavior notes.
- User flows: a strip of numbered step cards with arrows, a screenshot per step when the step cites one, the user action and the product's response; branches and untested paths below.
- Rules as Given/When/Then cards grouped by file; color swatches in the design system; an evidence gallery.
- Each image is embedded once and reused, so a screenshot cited by a screen, a component and a flow step adds no size. The page still builds when screenshots, screens or flows are missing.

## 0.3.1 (2026-10-16)

- `REPORT.html` redesigned for reading: a header with the product and study status, a notice that the page is for people and that AI agents should read `BUILD.md` (also as a comment at the top of the source), numbered sections in reading order (overview, product, screens, flows, rules, data, API, design, build plan, then what to prepare before launch), a coverage bar, rules and barriers as cards, IDs as badges.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ That depends on the product's terms and your jurisdiction. RES records the relev

## Status

Version 0.3.1. The method was tested with scenario runs on subagents, before and after each change to the skill, and the scripts with automated tests on Node.js 22 and 24. Two end-to-end studies on real products (ClickUp at L2, Pipedrive at L3) are in [examples/](examples/). Version 0.3.0 fixes the gaps the Pipedrive study found; the ClickUp study's are tracked in [an issue](https://github.com/alextnetto/res/issues/5). Reports from real runs are welcome: open a [study report](https://github.com/alextnetto/res/issues/new?template=study_report.yml).
Version 0.4.0. The method was tested with scenario runs on subagents, before and after each change to the skill, and the scripts with automated tests on Node.js 22 and 24. Two end-to-end studies on real products (ClickUp at L2, Pipedrive at L3) are in [examples/](examples/). Version 0.3.0 fixes the gaps the Pipedrive study found; the ClickUp study's are tracked in [an issue](https://github.com/alextnetto/res/issues/5). Reports from real runs are welcome: open a [study report](https://github.com/alextnetto/res/issues/new?template=study_report.yml).

## Responsible use

Expand Down
1,535 changes: 701 additions & 834 deletions examples/clickup/REPORT.html

Large diffs are not rendered by default.

1,076 changes: 486 additions & 590 deletions examples/pipedrive/REPORT.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"engines": {
"node": ">=22"
},
"version": "0.3.1",
"version": "0.4.0",
"license": "MIT",
"repository": {
"type": "git",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Initialize the KB as its own git repository (`init-kb.mjs --git`), even inside a

`node <skill>/scripts/pack-kb.mjs <kb>` writes `REPORT.html` in the KB and `<kb>-handoff-<date>.zip` next to the KB folder:

- `REPORT.html` is one self-contained page for people, in reading order: overview (summary, numbers, coverage, decisions needed), what the product does, screens, components, flows, how it behaves (rules), data model, API, design system, build plan (with acceptance tests), before you launch (barriers), topics, findings, open questions, about this study (charter, glossary, sources), and an evidence gallery. A notice at the top, and a comment at the top of the source, tell AI agents to read `BUILD.md` instead. Images are embedded and IDs are links; it has no scripts and makes no network requests. `build-report.mjs <kb>` regenerates it alone.
- `REPORT.html` is one self-contained page for people, in reading order: overview (summary, numbers, coverage, decisions needed), what the product does, screens, components, flows, how it behaves (rules), data model, API, design system, build plan (with acceptance tests), before you launch (barriers), topics, findings, open questions, about this study (charter, glossary, sources), and an evidence gallery. A notice at the top, and a comment at the top of the source, tell AI agents to read `BUILD.md` instead. Images are embedded once and reused, and IDs are links. Its only script is an inline theme toggle and click-to-zoom, and its only network request is Google Fonts (it falls back to system fonts offline). `build-report.mjs <kb>` regenerates it alone.

- It runs `check-kb` first and stops on errors (`--force` packs anyway and says so).
- It adds `BUILD.md` from `templates/handoff/BUILD.md` if the KB has none. Edit it in the KB to add instructions for a specific team.
Expand Down
Loading
Loading