Will it overwrite my existing README content?

No, it is designed to intelligently update or add relevant sections while maintaining the existing structure, hierarchy, and formatting of your README.md.

How does the skill know what to document?

It analyzes the current Git branch name, recent commit messages, and the actual diff of modified files to identify the scope and purpose of the new functionality.

Where does the documentation get saved?

The skill automatically detects standard directories like /docs or /documentation. If none exist, it can create a standard documentation directory for your project.

How does it handle links between documents?

It scans for related guides, tutorials, or ADRs and creates bidirectional links, ensuring that users can easily navigate between the new feature documentation and existing project context.

Automated Documentation Updater

Name: Automated Documentation Updater
Author: atournayre

byatournayre

•

学习与文档

Generates and synchronizes feature-specific documentation while keeping the project README and cross-links up to date.

The doc:update skill automates the tedious process of maintaining technical documentation by analyzing your current Git context, including branch names and commit history. It intelligently generates structured Markdown files for new features, updates the main project README to reflect changes, and establishes bidirectional links between related documents to prevent orphan pages. This tool ensures that your project's documentation remains as agile as your code, providing consistent, high-quality guides for developers and stakeholders alike.

主要功能

018 GitHub stars

02Automated Markdown generation for new features

03Bidirectional cross-linking between related documents

04Automated documentation directory discovery and setup

05Smart README synchronization and section updating

06Context-aware analysis of Git branches and file diffs

使用场景

01Preventing fragmented or 'orphan' documentation in large codebases

02Documenting a complex new feature before a Pull Request review

03Maintaining an up-to-date project README during rapid development cycles

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add atournayre/claude-marketplace update

For use in Claude.ai and ChatGPT

Download Skill