dx-audit

Audit developer experience across CLI, API, service, and GitHub Action surfaces with scored findings.

1|Updated Mar 24, 2026
One-click install
npx skills add https://github.com/SgtPooki/skills --skill dx-audit-sgtpooki
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: dx-audit
Source: https://github.com/SgtPooki/skills/tree/main/skills/dx-audit
Command: npx skills add https://github.com/SgtPooki/skills --skill dx-audit-sgtpooki

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve? Maintainers often cannot see the friction their own library or tool creates for new users — broken quickstarts, unstructured errors, missing machine-readable output, and unclear onboarding go unnoticed until support costs rise. This Skill audits a repository's developer experience across up to four surfaces and produces a scored, evidence-backed remediation plan. ## Core Features & Use Cases - Four-surface audit: Detects and audits CLI, programmatic library/API, server/service, and GitHub Action surfaces using prioritized P0/P1/P2 checklists. - Deterministic scoring: Scores each check 0/1/3/5 (with na renormalization) and rolls up category, surface, and overall scores via a dependency-free Node scorer. - Two audit tiers: A static tier for docs/source inspection and a fixture tier that runs clean-room consumer installs for real TTFS, success-rate, and example-reliability metrics. - Use Case: Run /dx-audit in a repo you maintain to get a report.md, scorecard.json, and prioritized remediation plan written to a temp directory, with quick wins ranked by impact and effort. ## Quick Start Ask the agent to run a DX audit on the current repository, for example by saying "audit the developer experience of this repo across all detected surfaces and give me the scored report."

Frequently Asked Questions about dx-audit

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit the developer experience of my CLI or library?▼

Run the dx-audit skill against your repository; it auto-detects which surfaces exist (CLI, library/API, service, GitHub Action) and walks prioritized checklists for each. It produces a scored report, machine-readable scorecard, and remediation plan in a temp output directory.

What surfaces does a DX audit cover?▼

The audit covers four surfaces: CLI, programmatic library/API, server/service, and GitHub Action. Each surface has its own P0/P1/P2 checklist grounded in sources like the CLI Guidelines, RFC 9457, OpenAPI, and GitHub's action authoring docs.

Does the DX audit require credentials or a live environment?▼

No. The default static tier inspects docs, source, and cheap probes like --help and exit codes without credentials. The fixture tier, which measures real TTFS and success rates, uses testnet or sandbox credentials when available and marks run-dependent metrics n/a otherwise.

How are DX audit scores calculated?▼

Each check is scored 0, 1, 3, or 5, with 'na' for genuinely absent or out-of-scope items. A bundled Node scorer script rolls checks into category, surface, and overall scores using fixed weights, renormalizing around na entries so scoped-out work is never penalized.

Will the audit write files into my repository?▼

No. All artifacts — report.md, scorecard.json, remediation-plan.md, and checks.json — are written to a temp directory keyed by repo name. Files are only written inside the repo if you explicitly request it and the path is already gitignored.