mirror of
https://github.com/pbakaus/impeccable.git
synced 2026-09-12 22:26:38 +03:00
* refactor(content): merge content/site/ into site/content/ Phase 1 step 1 of the directory restructure. The dual content tree was called out in CLAUDE.md as cleanup; both trees were already in sync except for anti-patterns-catalog.js, which moves to site/data/. - Delete content/site/skills/ and content/site/tutorials/ (duplicates of site/content/, which is what Astro's content collection actually reads). - Move content/site/anti-patterns-catalog.js -> site/data/. - Update scripts/lib/sub-pages-data.js and scripts/build.js to read from site/content/ and site/data/. - Drop content/site/ from validateProse target list (site/content was already there). - Rewrite the "Two content trees" section in CLAUDE.md as a single-tree pointer; update stale dev-server text mentioning the deleted server/index.js. Tests: 186/186 pass. Skills build: clean. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * refactor(skill): rename source/skills/impeccable/ -> skill/ Phase 1 step 2 of the directory restructure. The path was redundantly nested ("source/" wrapper plus "skills/impeccable/" — singular content hidden behind the plural). Collapses to flat skill/SKILL.md + skill/reference/ + skill/scripts/. - Move source/skills/impeccable/ -> skill/. - Rewrite scripts/lib/utils.js readSourceFiles(): drop the multi-skill iteration (CLAUDE.md commits to a single user-invocable skill); read skill/SKILL.md directly. - Update scripts/build.js, scripts/generate-og-image.js, and the sub-pages data layer to point at skill/. - Update tests/lib/utils.test.js: drop the "multi-skill" and "dir-name fallback" cases, update single-skill paths to skill/. - Update tests/build.test.js similarly: drop "multiple skills" integration test, update paths. - Update non-glob path joins in tests/framework-fixtures.test.mjs, tests/live-e2e/session.mjs, tests/live-e2e/agents/llm-agent.mjs, tools/live-loop.mjs. - Update prose/text references in CLAUDE.md, AGENTS.md, DEVELOP.md, README.md, scripts/lib/sub-pages-data.js, bin/commands/skills.mjs, site/data/anti-patterns-catalog.js, site/pages/docs/[...slug].astro, docs/adr-live-variant-mode.md, docs/plans/. Eval framework note: the separate impeccable-evals repo reads ../impeccable/source/skills/impeccable/ and needs a coordinated rename to ../impeccable/skill/. Tests: 186/186 pass. Skills build: clean. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * refactor: rename docs/ -> notes/ Phase 1 step 3 of the directory restructure. The internal docs/ dir (ADRs and plans) clashed with the site's /docs route. Renaming it "notes/" makes the difference unambiguous: notes/ is project-internal process, /docs is the user-facing route under site/pages/docs/. No code references the dir; the rename is a clean git mv. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * refactor(site): move public/ under site/public/ Phase 2 step 4 of the directory restructure. Public assets and the Astro publicDir now live alongside the rest of the site, so site/ is fully self-contained for static content. - git mv public site/public. - astro.config.mjs: add publicDir: './site/public'. Astro defaults to ./public at the project root, so the override is required. - scripts/build.js: write generated _data, _headers, _redirects, _routes.json, and js/detect-antipatterns-browser.js into site/public/. Also delete the dead _REMOVED() Bun static-site builder (replaced by Astro at #130; the placeholder no longer earns its keep). - scripts/build.js validateProse: replace the stale public/index.html reference (deleted at the Astro migration) with site/pages/index.astro in the count-validation file list, restoring homepage drift detection. - scripts/generate-og-image.js: write OG image into site/public/. - scripts/screenshot-antipatterns.js: read examples from + write screenshots to site/public/antipattern-{examples,images}/. - scripts/lib/sub-pages-data.js: load command demos from site/public/js/demos/commands. - .gitignore: rename the public/* generator-output entries to site/public/*. - CLAUDE.md: refresh CSS/data-file paths (still pointing at the old pre-Astro public/css/ + public/js/ tree), point the changelog and command-add checklists at site/pages/index.astro and site/scripts/data.js + site/scripts/components/framework-viz.js. Cloudflare Pages note: functions/ stays at the repo root because CF Pages auto-discovers it there with no configuration knob to relocate. Moving it under site/ would either break deployment or require a build-time copy step that adds more complexity than the cleanup is worth. Tests: 186/186 pass. Skills + site build clean. _headers, _redirects, _routes.json, _data/ all land in build/ correctly. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * refactor(cli): consolidate bin/ + src/ + lib/ under cli/ Phase 2 step 5 of the directory restructure. The CLI surface was split across three top-level dirs whose names were easy to mistake for each other (especially src/ vs source/ pre-step-2). Consolidates under cli/. - git mv bin -> cli/bin (CLI entry + skills sub-command) - git mv src -> cli/engine (detect-antipatterns engine + browser variant) - git mv lib -> cli/lib (download-providers helper) Update package.json: - bin.impeccable: cli/bin/cli.js - main + exports: cli/engine/detect-antipatterns.mjs and the ./browser variant - files: ["cli/", "LICENSE"] Update internal references: - cli/bin/cli.js: dynamic import points at ../engine/, package.json read goes one level deeper (../../package.json). - functions/api/download/[type]/[provider]/[id].js + bundle/[provider].js: cli/lib/download-providers.js path. - scripts/build.js, scripts/build-browser-detector.js, scripts/build-extension.js: cli/engine path constants. - scripts/lib/sub-pages-data.js, scripts/lib/utils.js, skill/scripts/ live-server.mjs: comment refs. - tests/detect-antipatterns{,-browser,-fixtures}.test.{js,mjs}, tests/windows-path-fix.test.js: import + read paths. - AGENTS.md, CLAUDE.md: doc paths. Verified: - npx node cli/bin/cli.js --version, --help, detect --help all work. - bun run build, bun run build:browser, bun run build:extension all clean. Browser detector lands at cli/engine/detect-antipatterns-browser.js; extension/detector/detect.js still emits to the same location. - bun run test: 186/186 pass. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * fix: update browser-detector paths missed in cli/ rename Bugbot caught two runtime path leaks where the comment got renamed to cli/engine/ but the actual code still used the old src/ segment. - skill/scripts/live-server.mjs: detectPaths array now joins cli, engine, detect-antipatterns-browser.js for both the repo-relative lookup (4 dirs up from .claude/skills/impeccable/scripts/ to repo root) and the npm node_modules fallback. Without this fix, the detection overlay would silently not load during live-server sessions. - scripts/build.js: the post-build copy of the browser detector into site/public/js/ was reading from src/. The if (fs.existsSync(...)) guard meant the copy was silently skipping, so antipattern-examples pages would 404 on /js/detect-antipatterns-browser.js once the site was deployed. Tests: 186/186 pass. Build clean. site/public/js/detect-antipatterns-browser.js re-emits as expected. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * fix: cleanup-deprecated import path missed an extra .. in cli/ rename Bugbot caught three call sites in cli/bin/commands/skills.mjs that import '../../skill/scripts/cleanup-deprecated.mjs'. Pre-rename, that was correct from bin/commands/ (one parent to bin/, one to repo root). After moving the file from bin/commands/ to cli/bin/commands/, the path is one directory deeper, so it needs three .. segments to reach the repo root. Without the fix, every cleanup invocation throws on import and gets swallowed by the surrounding try/catch — silent skip. cli/bin/cli.js's package.json read already uses '../../package.json' (the same depth pattern), confirming three levels is correct. Verified: dynamic import resolves and exports the expected functions. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * chore: sweep stale path/file references missed in the restructure Same root cause as the two bugbot finds: some references in moved or related files weren't tracked because they didn't match a simple sed pattern. Caught the rest by walking each moved dir's depth and each Astro-migration deletion. Stale path references (post-Astro migration, missed earlier): - CLAUDE.md: legacy URL redirects "live in server/index.js" -> point at the actual sources (scripts/build.js generateCFConfig + site/public/_redirects). - AGENTS.md: counts.js path (public/ -> site/public/), changelog file (public/index.html -> site/pages/index.astro), screenshots note (public/ -> site/), source-of-truth dirs (source/, src/ -> skill/, cli/). - tests/detect-antipatterns-browser.test.mjs: comment about routes "in server/index.js". - skill/reference/live.md: workflow.css example for "this repo" was pre-Astro (public/css/) -> site/styles/. (User-project Vite/Next example unchanged.) Stale path that pointed at moved files: - tests/skills-cli.test.js: CLI path was '..', 'bin', 'cli.js'; now '..', 'cli', 'bin', 'cli.js'. Test isn't wired into bun run test but it would have failed if invoked. Dead files (orphaned by Astro migration, never cleaned up): - tests/server/download-validation.test.js: imported from ../../server/lib/{validation,api-handlers}.js which were deleted inb8f09c8. Test was a silent failure waiting to happen. - scripts/lib/render-markdown.js: 156-line module with zero consumers (the only caller, scripts/lib/render-page.js, was deleted in the Astro cleanup). - scripts/build.js: dead commented-out generateSubPages import. Tests: 186/186 pass. Build clean. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * fix(build): remove invalid Corepack packageManager spec Cloudflare Pages rejects the build with `Unsupported package manager specification (bun@1.3.11)`. The packageManager field follows Corepack's syntax which only validates npm/pnpm/yarn — `bun@X.Y.Z` parses as a malformed Corepack directive even though Bun itself treats it as a hint. Pre-existing on main sinced874af0(CF Pages deploy on main also failing); just surfaces here because the PR triggers a fresh deploy. CF Pages auto-detects Bun anyway (the build log confirms: "Detected the following tools from environment: bun@1.3.11, pnpm@10.11.1, nodejs@22.16.0"). Removing the field unblocks the deploy without changing local dev behavior. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Paul Bakaus <paulbakaus@pauls-mbp-3.lan> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
175 lines
6.0 KiB
Markdown
175 lines
6.0 KiB
Markdown
> **Additional context needed**: audience technical level and users' mental state in context.
|
|
|
|
Find the unclear, confusing, or poorly written interface text and rewrite it. Vague copy creates support tickets and abandonment; specific copy gets users through the task.
|
|
|
|
|
|
---
|
|
|
|
## Assess Current Copy
|
|
|
|
Identify what makes the text unclear or ineffective:
|
|
|
|
1. **Find clarity problems**:
|
|
- **Jargon**: Technical terms users won't understand
|
|
- **Ambiguity**: Multiple interpretations possible
|
|
- **Passive voice**: "Your file has been uploaded" vs "We uploaded your file"
|
|
- **Length**: Too wordy or too terse
|
|
- **Assumptions**: Assuming user knowledge they don't have
|
|
- **Missing context**: Users don't know what to do or why
|
|
- **Tone mismatch**: Too formal, too casual, or inappropriate for situation
|
|
|
|
2. **Understand the context**:
|
|
- Who's the audience? (Technical? General? First-time users?)
|
|
- What's the user's mental state? (Stressed during error? Confident during success?)
|
|
- What's the action? (What do we want users to do?)
|
|
- What's the constraint? (Character limits? Space limitations?)
|
|
|
|
**CRITICAL**: Clear copy helps users succeed. Unclear copy creates frustration, errors, and support tickets.
|
|
|
|
## Plan Copy Improvements
|
|
|
|
Create a strategy for clearer communication:
|
|
|
|
- **Primary message**: What's the ONE thing users need to know?
|
|
- **Action needed**: What should users do next (if anything)?
|
|
- **Tone**: How should this feel? (Helpful? Apologetic? Encouraging?)
|
|
- **Constraints**: Length limits, brand voice, localization considerations
|
|
|
|
**IMPORTANT**: Good UX writing is invisible. Users should understand immediately without noticing the words.
|
|
|
|
## Improve Copy Systematically
|
|
|
|
Refine text across these common areas:
|
|
|
|
### Error Messages
|
|
**Bad**: "Error 403: Forbidden"
|
|
**Good**: "You don't have permission to view this page. Contact your admin for access."
|
|
|
|
**Bad**: "Invalid input"
|
|
**Good**: "Email addresses need an @ symbol. Try: name@example.com"
|
|
|
|
**Principles**:
|
|
- Explain what went wrong in plain language
|
|
- Suggest how to fix it
|
|
- Don't blame the user
|
|
- Include examples when helpful
|
|
- Link to help/support if applicable
|
|
|
|
### Form Labels & Instructions
|
|
**Bad**: "DOB (MM/DD/YYYY)"
|
|
**Good**: "Date of birth" (with placeholder showing format)
|
|
|
|
**Bad**: "Enter value here"
|
|
**Good**: "Your email address" or "Company name"
|
|
|
|
**Principles**:
|
|
- Use clear, specific labels (not generic placeholders)
|
|
- Show format expectations with examples
|
|
- Explain why you're asking (when not obvious)
|
|
- Put instructions before the field, not after
|
|
- Keep required field indicators clear
|
|
|
|
### Button & CTA Text
|
|
**Bad**: "Click here" | "Submit" | "OK"
|
|
**Good**: "Create account" | "Save changes" | "Got it, thanks"
|
|
|
|
**Principles**:
|
|
- Describe the action specifically
|
|
- Use active voice (verb + noun)
|
|
- Match user's mental model
|
|
- Be specific ("Save" is better than "OK")
|
|
|
|
### Help Text & Tooltips
|
|
**Bad**: "This is the username field"
|
|
**Good**: "Choose a username. You can change this later in Settings."
|
|
|
|
**Principles**:
|
|
- Add value (don't just repeat the label)
|
|
- Answer the implicit question ("What is this?" or "Why do you need this?")
|
|
- Keep it brief but complete
|
|
- Link to detailed docs if needed
|
|
|
|
### Empty States
|
|
**Bad**: "No items"
|
|
**Good**: "No projects yet. Create your first project to get started."
|
|
|
|
**Principles**:
|
|
- Explain why it's empty (if not obvious)
|
|
- Show next action clearly
|
|
- Make it welcoming, not dead-end
|
|
|
|
### Success Messages
|
|
**Bad**: "Success"
|
|
**Good**: "Settings saved! Your changes will take effect immediately."
|
|
|
|
**Principles**:
|
|
- Confirm what happened
|
|
- Explain what happens next (if relevant)
|
|
- Be brief but complete
|
|
- Match the user's emotional moment (celebrate big wins)
|
|
|
|
### Loading States
|
|
**Bad**: "Loading..." (for 30+ seconds)
|
|
**Good**: "Analyzing your data... this usually takes 30-60 seconds"
|
|
|
|
**Principles**:
|
|
- Set expectations (how long?)
|
|
- Explain what's happening (when it's not obvious)
|
|
- Show progress when possible
|
|
- Offer escape hatch if appropriate ("Cancel")
|
|
|
|
### Confirmation Dialogs
|
|
**Bad**: "Are you sure?"
|
|
**Good**: "Delete 'Project Alpha'? This can't be undone."
|
|
|
|
**Principles**:
|
|
- State the specific action
|
|
- Explain consequences (especially for destructive actions)
|
|
- Use clear button labels ("Delete project" not "Yes")
|
|
- Don't overuse confirmations (only for risky actions)
|
|
|
|
### Navigation & Wayfinding
|
|
**Bad**: Generic labels like "Items" | "Things" | "Stuff"
|
|
**Good**: Specific labels like "Your projects" | "Team members" | "Settings"
|
|
|
|
**Principles**:
|
|
- Be specific and descriptive
|
|
- Use language users understand (not internal jargon)
|
|
- Make hierarchy clear
|
|
- Consider information scent (breadcrumbs, current location)
|
|
|
|
## Apply Clarity Principles
|
|
|
|
Every piece of copy should follow these rules:
|
|
|
|
1. **Be specific**: "Enter email" not "Enter value"
|
|
2. **Be concise**: Cut unnecessary words (but don't sacrifice clarity)
|
|
3. **Be active**: "Save changes" not "Changes will be saved"
|
|
4. **Be human**: "Oops, something went wrong" not "System error encountered"
|
|
5. **Tell users what to do**, not just what happened
|
|
6. **Be consistent**: Use same terms throughout (don't vary for variety)
|
|
|
|
**NEVER**:
|
|
- Use jargon without explanation
|
|
- Blame users ("You made an error" → "This field is required")
|
|
- Be vague ("Something went wrong" without explanation)
|
|
- Use passive voice unnecessarily
|
|
- Write overly long explanations (be concise)
|
|
- Use humor for errors (be empathetic instead)
|
|
- Assume technical knowledge
|
|
- Vary terminology (pick one term and stick with it)
|
|
- Repeat information (headers restating intros, redundant explanations)
|
|
- Use placeholders as the only labels (they disappear when users type)
|
|
|
|
## Verify Improvements
|
|
|
|
Test that copy improvements work:
|
|
|
|
- **Comprehension**: Can users understand without context?
|
|
- **Actionability**: Do users know what to do next?
|
|
- **Brevity**: Is it as short as possible while remaining clear?
|
|
- **Consistency**: Does it match terminology elsewhere?
|
|
- **Tone**: Is it appropriate for the situation?
|
|
|
|
When the copy reads cleanly, hand off to `{{command_prefix}}impeccable polish` for the final pass.
|