project-readme

Project README

Create or assess a useful project entry point from repository evidence. Adapt the bundled template to the project's readers and local rules rather than treating it as a mandatory section checklist. This skill is guidance, not a runtime guard, and loading it does not install, enable, publish, or modify anything by itself.

When to Use

Use this skill for a repository-level request to:

• create a missing project README;
• update, restructure, or harmonize an existing project README;
• audit or review a project README against repository evidence and documentation policy.

Do not use it for:

• general copywriting, release notes, blog posts, or arbitrary Markdown cleanup;
• writing API references, contributor guides, security policies, or package metadata as the primary task;
• changing implementation, packaging, publication, installation, or runtime configuration;
• rewriting many repositories or sibling projects without explicit per-destination scope;
• reviewing code quality when the project README is not the requested artifact.

Should trigger

• “Create the top-level README for this application from the repository contents.”
• “Update this library README with a verified quick start and public documentation links.”
• “Review our project README for unsupported claims and misplaced contributor details.”
• “Harmonize this repository README with its local documentation rules.”

Should not trigger

• “Write an API endpoint reference for this service.”
• “Fix the implementation and add tests.”
• “Draft release notes for the next version.”
• “Reformat every Markdown file in the organization.”

Ambiguous requests

A request such as “improve the docs” does not establish the artifact or write scope. Determine whether the user means the project README; otherwise route to the documentation workflow matching the actual artifact. A request to “document this package” may need a user-facing project README, an API reference, contributor documentation, or several separately scoped documents. Do not silently widen it.