readme-driven-development

Drafts and refines a user-facing README as the canonical design contract before implementation.

2|Updated Apr 2, 2026
One-click install
npx skills add https://github.com/nseng-ai/ns --skill readme-driven-development-nseng-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: readme-driven-development
Source: https://github.com/nseng-ai/ns/tree/main/skills/internal/agent-engineering/readme-driven-development
Command: npx skills add https://github.com/nseng-ai/ns --skill readme-driven-development-nseng-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Teams often start coding before agreeing on what the product actually does, leading to mismatched expectations, scope drift, and undocumented design decisions. This Skill makes the README the canonical, user-facing design contract and settles every open design question before implementation begins. ## Core Features & Use Cases - README-first drafting: Writes or locates the canonical README describing the system as if it already exists, covering only what a user sees, runs, and reads. - Structured design interview: Grills the user one question at a time on unsettled decisions, always offering a recommended answer that a plain "yes" can endorse, and explores the codebase instead of asking when answers are discoverable. - Settle and report loop: Folds answers back into the README, edits clarity issues directly, asks before changing scope, and ends each pass with a report of settled decisions, open questions, and next actions. - Use Case: Before building a new CLI tool, run a pass to draft its README, resolve questions about flags, output formats, and error behavior, then hand the settled README to implementers as the contract. ## Quick Start Ask the agent to run a readme-driven-development pass on the feature you are about to build, starting by drafting or reviewing its README.

Frequently Asked Questions about readme-driven-development

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

FAQPage Schema
How do I design a feature README-first before writing code?

Draft the README as if the product already exists, describing only what users see and run. Then interview stakeholders on every unsettled decision, fold the answers back into the README, and repeat until it reads as coherent product documentation.

What is readme-driven development?

Readme-driven development is a workflow where the README is written before the software and treated as the canonical design contract. A decision counts as settled only when it appears in, or is explicitly linked from, the README.

Does the README track implementation tasks and progress?

No. Execution state such as slices, status, and tasks lives outside the README in a roadmap or tracker. The README stays exclusively user-facing, describing what a user would read about the finished product.

When is a README design pass considered done?

A pass is done when the README is coherent: no contradictions, no silently invented commitments, and a clear user-facing story. Open questions may remain as long as they are visible in the README; completeness is not required.

When should I not use readme-driven development?

Avoid it for trivial changes, bug fixes, or spikes where the user-facing behavior is already obvious and uncontested. The interview loop adds the most value when design decisions are genuinely unsettled or disputed.