External DX audit sample

What a first-developer audit returns.

This sample shows the written DX pass: first-run path, install and docs gaps, proof boundaries, first fixes, and the stop rule for one public repo. It uses public repo metadata and docs only.

Buy the $149 mini-audit Build intake brief Raw Markdown sample

Sample only. Real DX audits use the buyer's public repo, docs, public demo, and safe local/test inputs. No private repo access, secrets, credentials, customer data, payment data, account access, or calls.

5

Run commands visible

450

README characters

0

Root docs/example dirs

6

First fixes returned

Executive Summary

Status: red. The repo can be evaluated, but a stranger does not get a clear first-run path, install command, troubleshooting route, or data boundary from the visible docs. Fix those before asking outsiders to trust the demo or contribute.

First Developer Path

Signal Observed
Visible scriptsbuild, test, lint, typecheck, dev
Docs/examples/demo dirsNone visible at repo root
LicenseVisible
Contributing guideMissing

DX Findings

  1. README does not expose a clear first-run path. Fix: add a short quickstart from clone/install to a working example.
  2. Install command is not obvious. Fix: add the exact install command a stranger should run.
  3. No docs/examples/demo directory is visible at the repo root. Fix: add a minimal example or demo path.
  4. CONTRIBUTING.md is missing. Fix: add local development and contribution notes for outside reviewers.
  5. Troubleshooting path is not visible. Fix: add a short troubleshooting or known-limits section.
  6. Data and secret boundary is not visible. Fix: state what data the tool needs and what should never be sent.

What This Proves

  • A stranger can see whether the repo explains what it is, how to install it, how to run it, and how to verify it.
  • The audit separates missing proof from subjective taste.
  • The output is scoped enough to hand to a maintainer or founder without a meeting.

Generated By

npm run service:dx-demo
npm run service:fulfill -- --issue <public-dx-intake> --payment-verified
npm run service:delivery-draft -- --report <customer-report> --buyer-email <buyer>