skills.rest
chris-prener
chris-prenerCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

readme

Audits and updates README.md to match the current codebase state.

Updated Jul 29, 2026
Search Tags:#documentation#markdown#audit#readme#maintenance#github issues#link checking
One-click install
npx skills add https://github.com/chris-prener/dev-kit --skill readme-chris-prener
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme
Source: https://github.com/chris-prener/dev-kit/tree/main/dev-kit/skills/readme
Command: npx skills add https://github.com/chris-prener/dev-kit --skill readme-chris-prener

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? READMEs drift out of sync with the code they describe: placeholder sections stay unfilled, dependency tables list removed packages, and links rot. This Skill audits a repository's README.md against the actual codebase and updates it in place while preserving the existing structure and voice. ## Core Features & Use Cases - Section-by-section audit: Classifies every README section as placeholder, stale, accurate, or missing, then fills or fixes it using facts gathered from the source code. - Fact verification: Rebuilds dependency and public function/API tables from actual imports and exports, verifies internal links and anchor targets, and removes content that contradicts the code. - Issue filing for unresolved findings: Auto-files GitHub issues via the backlog skill for non-trivial findings (broken links, stale tables, contradictions with docs/walkthrough.md) using a stable check-ID inventory. - Use Case: After a refactor that removed two dependencies and added a new public API, ask for a README refresh to get an updated README plus filed issues for anything that cannot be fixed in place. ## Quick Start Ask the assistant to audit and refresh this repository's README so it matches the current codebase.

Frequently Asked Questions about readme

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

FAQPage Schema
How do I update a README to match my codebase?▼

Run a README audit that scans source files for dependencies, public functions, and inputs, then updates each README section in place. The skill preserves existing structure and voice while replacing placeholders and stale content with verified facts.

How to check a README for broken links and stale content?▼

The audit phase collects every link in the README and verifies internal paths and anchor targets against actual files, while flagging suspicious external URLs. Sections are classified as placeholder, stale, accurate, or missing so only incorrect content changes.

Does the README audit rewrite my documentation from scratch?▼

No. The skill explicitly preserves existing headings, ordering, and tone, filling gaps rather than reorganizing. It refuses to redesign the README and defers deep technical explanation to docs/walkthrough.md.

What happens to README problems that cannot be fixed immediately?▼

Non-trivial findings are auto-filed as GitHub issues through the backlog skill using the tech_debt template, with stable check-IDs like broken-link or stale-dependency-table and severity-derived priority labels. Low-severity style nits are not filed.

When should I not use a README maintenance skill?▼

Avoid it for deep technical explanation or system-internals documentation, which belongs in a walkthrough document. It also does not modify code, refactor referenced functions, or handle files outside the repo root README.

Related Skills

Explore More Software Engineering Skills→
Junior-Frontend-devJunior-Frontend-dev

project-documentation

Generate layered README, architecture, walkthrough, and API reference documentation from a codebase.

Community
Advanced
twjarviszyra-webtwjarviszyra-web
3

github-issues

Manage GitHub issues via the REST API or gh CLI.

Community
Intermediate
SocketDevSocketDev
125

updating-coverage

Run coverage scripts with pnpm and update the README badge.

Official
Advanced
maestria-comaestria-co

context-maintenance

Update .context documentation by promoting retrospectives and pruning stale content.

Official
Intermediate