An evidence-driven, project-type-aware skill for Codex and Claude Code that creates or regenerates a software project's root README with portable installation and deterministic validation.
write-complete-project-readme is a AI-agent skill created to make a real workflow clearer, faster, and easier to trust. It turns a focused product idea into something people can use, evaluate, and understand without needing to inspect the source code.
Why write-complete-project-readme exists
README generators often preserve stale claims or produce generic sections because they do not inspect the actual project or distinguish evidence from inference.
The goal is not simply to add another tool. write-complete-project-readme is designed to reduce the friction around that problem and give people a more dependable way to complete the work.
What it delivers
- Agents can produce audience-first setup and usage docs.
- Preserve verified voice/attribution while removing stale claims.
- Surface material absences such as missing licenses.
- Validate that the finished README is complete.
The experience
Installs one portable skill for Codex, Claude Code, or both that creates complete project READMEs from verified repository evidence.
The project brings the important parts of the workflow into one coherent experience. Its interface and behavior are shaped around the people using it, while the implementation stays focused on predictable results and honest feedback.
What to know
Every product has boundaries. These are the most important considerations for write-complete-project-readme:
- The skill may edit only the root README.
- Features, commands, compatibility, status, URLs, metrics, and license terms cannot be invented.
- Applications, packages, APIs, CLIs, monorepos, datasets, and skills require different reading flows.
These limitations are presented openly so visitors can understand where the project works well, what it depends on, and what may change in future versions.
Current status
Published npm package v0.4.0. The current release demonstrates the core value of the project and the main end-to-end experience.
My role was agent workflow design and automation engineering, covering agent workflow, validation automation, and packaging. The related case study explains the decisions and delivery process in greater depth for visitors who want the engineering story behind the product.