skills.rest
billwanggithub
billwanggithubCOMMUNITY
Explore all skills by this author →
GitHub

update-docs

Update project documentation files from recent code changes.

Updated Feb 25, 2026
Search Tags:#documentation#version control#technical writing#readme#code sync#project status
One-click install
npx skills add https://github.com/billwanggithub/GmtTestToolV1 --skill update-docs-billwanggithub
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/billwanggithub/GmtTestToolV1/tree/main/.agent/skills/update-docs
Command: npx skills add https://github.com/billwanggithub/GmtTestToolV1 --skill update-docs-billwanggithub

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures that project documentation, including README, PROJECT_STATUS, and GEMINI.md, accurately reflects the latest codebase changes, preventing outdated information and maintaining project clarity.

Core Features & Use Cases

  • Automated Documentation Updates: Systematically updates key project files to mirror recent development.
  • Status Tracking: Manages the "Recently Completed" and "Current Obstacles" sections in PROJECT_STATUS.md.
  • Contextual Archiving: Appends technical changes to GEMINI.md under "Latest Updates".
  • Use Case: After implementing a new feature and refactoring a module, use this skill to update the README.md with the new capability, add the refactoring details to GEMINI.md, and mark the feature as completed in PROJECT_STATUS.md.

Quick Start

Update all project documentation files to reflect recent changes.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I keep project documentation in sync with recent codebase changes?▼

To keep project documentation in sync with codebase changes, you can automate updates to README.md, PROJECT_STATUS.md, and GEMINI.md. The skill analyzes git logs or conversation history to identify relevant updates and reflect them accurately in your docs.

What is the best way to update task statuses and obstacles in PROJECT_STATUS.md?▼

The best way to update task statuses and obstacles in PROJECT_STATUS.md is using an automated documentation synchronization tool. This skill systematically manages the "Recently Completed" and "Current Obstacles" sections based on recent development progress.

Can I append architectural notes and technical changes to GEMINI.md automatically?▼

Yes, you can append technical changes to GEMINI.md automatically. The skill contextualizes recent codebase updates and appends them under the "Latest Updates" section to maintain a clear architectural history.

Does documentation synchronization work without analyzing git logs?▼

Documentation synchronization requires analyzing git logs or conversation history to identify relevant updates. Without these input sources, the skill cannot detect recent codebase changes to mirror in your project files.

When do I need to update README.md with new feature descriptions?▼

You need to update README.md with new feature descriptions after implementing new capabilities or refactoring modules. This ensures project documentation accurately reflects the latest codebase changes and prevents outdated information.

Related Skills

Explore More Software Engineering Skills→
Sir-chawakornSir-chawakorn
9

write-docs

Generate and maintain project documentation from source code and git history.

Community
Advanced
SynkraAISynkraAI
3.1k

aiox-devops

Manage GitHub repositories and automate CI/CD workflows with quality gates.

Official
Advanced
Renzo-TognellaRenzo-Tognella

documentation

Generate and maintain technical documentation for Ruby on Rails applications.

Community
Advanced
shafibabarshafibabar
1

feature-flag-design

Audit feature flag inventories for ownership and removal dates.

Community
Advanced