update-docs

Update README.md, CLAUDE.md, and game-mechanics.md from change summaries.

5|Updated Jan 2, 2026
One-click install
npx skills add https://github.com/suzbot/petri --skill update-docs-suzbot
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/suzbot/petri/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/suzbot/petri --skill update-docs-suzbot

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the process of updating project documentation to reflect recent changes, ensuring that documentation remains accurate and useful for its intended audience.

Core Features & Use Cases

  • Targeted Updates: Modifies specific documentation files (README.md, CLAUDE.md, docs/game-mechanics.md, etc.) based on provided summaries of changes.
  • Audience-Specific Content: Adapts updates based on the target audience of each document (players, AI context, developers).
  • Use Case: After implementing a new feature like "Plant Orders" in the game, use this Skill to update the "Latest Updates" section of the README.md and add the new mechanic to docs/game-mechanics.md.

Quick Start

Use the update-docs skill to update the project documentation with the summary "Added plant orders and wet tiles".

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I update project documentation after implementing new features?

To update project documentation after new features, provide a summary of changes to automatically modify files like README.md and game-mechanics.md, ensuring documentation accurately reflects implemented functionality and recent bug fixes.

Can I tailor README.md updates for different audiences like players and developers?

Yes, you can tailor README.md updates for different audiences. The documentation process adapts content specifically for players, AI context, and developers, adhering to distinct update rules for each file to match the target audience.

What is the best way to keep technical writing and project docs current?

The best way to keep technical writing and project docs current is by automating file updates with provided change summaries. This ensures documentation accuracy by consistently reflecting implemented features across multiple project files.

How do I add new game mechanics to game-mechanics.md using a change summary?

To add new game mechanics to game-mechanics.md, submit a change summary describing the update. The documentation modification process automatically integrates the new mechanics into the appropriate technical writing files.

Does updating CLAUDE.md require providing an AI context summary?

Updating CLAUDE.md requires providing a change summary that serves as AI context. The process tailors the documentation content specifically for AI context audiences, adhering to specific update rules for the file.

What limitations exist when automating documentation updates from change summaries?

A limitation of automating documentation updates is that it relies entirely on the provided change summary. It modifies specific predefined files like README.md and game-mechanics.md, meaning undocumented changes or unlisted file formats will not be processed.