skills.rest
lucidlabs-hq
lucidlabs-hqOFFICIAL
Explore all skills by this author →
WebsiteGitHub

update-readme

Update README sections from PROJECT-STATUS.md and PRD changes.

2|1|Updated Jan 27, 2026
Search Tags:#documentation#readme#quality#docs#update#project-status
One-click install
npx skills add https://github.com/lucidlabs-hq/agent-kit --skill update-readme-lucidlabs-hq
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-readme
Source: https://github.com/lucidlabs-hq/agent-kit/tree/main/.claude/skills/update-readme
Command: npx skills add https://github.com/lucidlabs-hq/agent-kit --skill update-readme-lucidlabs-hq

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manually updating READMEs to reflect current project status is error-prone and time-consuming.

Core Features & Use Cases

  • Automatically scan and align README with the latest status from PROJECT-STATUS.md and PRD.
  • Update sections describing features, scope, and progress to keep stakeholders informed.
  • Use case: after finishing a major feature, run this to ensure the README mirrors delivered work and planned roadmap.

Quick Start

Run the update-readme skill to refresh the README with the latest status from your project docs.

Frequently Asked Questions about update-readme

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

FAQPage Schema
How do I automatically update README to reflect current project status?▼

To update your README to reflect current project status, run the update-readme skill to automatically scan and align README content with the latest status from PROJECT-STATUS.md and an optional PRD.

Why does my README have outdated features and project scope after a release?▼

Your README has outdated features and project scope because manual synchronization is error-prone. Automating the update process ensures the README mirrors delivered work and planned roadmap accurately.

When do I need to sync project documentation with development progress?▼

You need to sync project documentation with development progress when features are completed, PRD updates occur, or before releases, ensuring stakeholders stay informed about the current scope and delivered work.

Does update-readme require a PRD file to update documentation?▼

No, update-readme does not require a PRD file to update documentation. It reads PROJECT-STATUS.md as the primary source and optionally incorporates the PRD to align the README with planned roadmap changes.

What is the best way to keep stakeholders informed about completed features?▼

The best way to keep stakeholders informed about completed features is to automate README updates after finishing major work, ensuring the documentation accurately mirrors delivered work and the planned roadmap.

Can I use this to update project docs before a major release?▼

Yes, you can use this to update project docs before a major release. It reads your current PROJECT-STATUS.md and optional PRD to refresh the README, ensuring all feature descriptions and progress sections are accurate.

Related Skills

Explore More Content & Communication Skills→
DojoGenesisDojoGenesis
2

decision-propagation

Propagate architectural decisions across interconnected project documents and flag conflicts.

Community
Advanced
oletizioletizi

feature-complete

Finalize feature docs, update ROADMAP, and close related issues on feature branches.

Community
Advanced
NourcineAbNourcineAb

github-project-management

Automate GitHub issue tracking, board synchronization, and sprint planning workflows.

Community
Advanced
CHNISamCHNISam

install-skills-global

Detect installed Windows code editors and copy skill directories to selected targets.

Community
Basic