harness-dx

Audit README quality, API documentation coverage, and getting-started guides into a DX scorecard.

18|11|Updated Mar 16, 2026

Search Tags:#documentation #readme #dx #getting-started #api-docs #developer-experience

Ready to run

npx skills add https://github.com/Intense-Visions/harness-engineering --skill harness-dx

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: harness-dx
Source: https://github.com/Intense-Visions/harness-engineering/tree/main/agents/skills/claude-code/harness-dx
Command: npx skills add https://github.com/Intense-Visions/harness-engineering --skill harness-dx

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit README quality, API documentation coverage, and getting-started guides to identify gaps and provide structured improvement plans for developer onboarding.

Core Features & Use Cases

Audit README quality, API documentation coverage, and getting-started guides across a codebase.
Generate a structured DX scorecard with actionable improvements and scaffolds missing documentation.
Scaffold concise getting-started guides, API references, and example validations to streamline onboarding.

Quick Start

Invoke the DX audit on a repository by running harness skill run harness-dx with the path to the project root.

Frequently Asked Questions about harness-dx

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

FAQPage Schema

How do I audit README quality and API documentation coverage for my SDK?▼

Audit README quality and API documentation coverage by running a DX evaluation on your repository root, which validates existing docs and generates a structured scorecard with actionable improvement plans for developer onboarding.

What is a developer experience scorecard and how does it identify onboarding gaps?▼

A developer experience scorecard is a structured evaluation of your project's README, API docs, and getting-started guides that identifies missing documentation and suggests scaffolds to reduce developer onboarding friction.

Can I scaffold missing getting-started guides and API references for a library?▼

Yes, you can scaffold missing getting-started guides and API references by running the DX audit, which detects missing documentation artifacts and generates concise scaffolds to streamline developer onboarding for libraries and SDKs.

Does the DX audit validate example code in the documentation?▼

Yes, the DX audit optionally validates example code alongside checking README quality and API documentation coverage, ensuring that getting-started guides and references are both present and functional for developers.

What's the best way to improve developer adoption for a new codebase?▼

Improve developer adoption by auditing your project's README, API documentation, and getting-started guides to produce a DX scorecard, which highlights onboarding friction and scaffolds missing documentation to streamline integration.

Do I need to install any dependencies to run a developer experience audit?▼

No dependencies are required to run the developer experience audit; you can invoke the audit directly against your project root path to evaluate documentation quality and generate an improvement scorecard without external packages.