Menu
Create a concise, complete, developer-focused README.md for software projects that experienced developers can use immediately.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
Orchestrate development work through sub-agents using td for state. Use when given a td task ID, text idea, markdown plan, or td epic to execute through plan-implement-review loops.
Set up and run autonomous overnight coding loops that process td epic tasks one at a time. Includes the loop runner, Rich TUI cockpit dashboard, and prompt template. Use when automating multi-day feature development across many tasks with td for state management.
Start a td review session and do a detailed review of open reviews. Fix obvious bugs immediately, create tasks for bigger issues, ensure test coverage, and use parallel subagents for independent reviews. Use when you want to review and triage pending td reviews.
Task management for AI agents across context windows. Use when agents need to track work, log progress, hand off state, and maintain context across sessions. Includes workflows for single-issue focus, multi-issue work sessions, and structured handoffs. Essential for AI-assisted development where context windows reset between sessions.
Create and maintain DESIGN.md files — a design system specification optimized for AI consumption. Use when creating a project's design system file, extracting tokens from existing CSS/code, auditing design consistency, or onboarding an agent to a project's visual language.
Write naturally and avoid AI-detectable patterns. Use when (1) generating any written content, (2) reviewing/editing text for AI-like patterns, (3) user asks to make writing sound more human/natural, or (4) improving text that sounds robotic or generic. Covers vocabulary, structure, tone, and formatting tells that signal AI authorship.
| name | professional-readme |
| description | Create a concise, complete, developer-focused README.md for software projects that experienced developers can use immediately. |
| metadata | {"author":"marcus-vorwaller","version":"1.0"} |
This skill standardizes README.md creation for software projects targeting experienced developers. The resulting README should be clear, concise, and actionable—not verbose, decorative, or redundant.
Good README.md files answer a core set of questions quickly:
This skill produces structured, scannable READMEs with precise labels and instructions. A README that reliably gets developers productive in under 10 minutes is successful. oai_citation:0‡DEV Community
Use when a project needs:
Do not use when:
When drafting:
When activated, produce:
The recommended sequence below supports scan first, dive later patterns.
Short, descriptive title with an optional tagline.
Example:
project-name
A fast, modular CLI for managing distributed workflows.
Taglines answer: what it is and why you care. oai_citation:2‡freeCodeCamp
Summarize core function and distinguishing aspects. Include key constraints or intended use cases. Avoid long narratives.
Short status (e.g., active development / stable / maintenance) with links to detailed roadmap artifacts (issues/milestones). oai_citation:3‡Archbee
Only include if the README is long. Keep this minimal.
Fastest path to running or using the project:
install
git clone …
build
make
run
./project –help
Include prerequisites, versions, and notable environment settings. oai_citation:4‡freeCodeCamp
Command-by-command setup steps. Use explicit code blocks.
Show 3–5 common patterns developers will care about:
Concise overview of:
Keep this section brief and link to deeper docs when necessary. oai_citation:5‡Archbee
Cover local dev bootstrapping:
Commands and expectations for running test suites and quality tooling.
High-level guide plus link to CONTRIBUTING.md (not duplicated). Include tests and review expectations. Refer to standard conventions. oai_citation:6‡Wikipedia
Clear license declaration with link to LICENSE file. Optionally include short license text if brief.
Where to get help (issues, Slack, email). Only include if relevant.
## Installation, ## Usage)External docs should not be duplicated; they should be linked. oai_citation:8‡Archbee
Before finalizing: