Does it support existing documentation structures?

Yes, it automatically scans for directories like /docs or /documentation and adheres to your project's existing formatting and hierarchy.

How does it handle navigation between documents?

It identifies related guides, architecture records, or tutorials and adds bidirectional links to ensure the new documentation is integrated into the wider documentation web.

How does the skill know what to document?

It analyzes your current Git branch name, recent commit messages, and the diff of modified files to understand the context and purpose of the feature being developed.

Can it update my main README.md file?

Yes, the skill is designed to verify if a feature should be mentioned in the main README and will update sections like 'Features' or 'Project Structure' accordingly.

Does it validate the generated documentation?

Yes, it performs a validation step to ensure all code examples are functional, links are valid, and the Markdown formatting is correct before finishing.

Automated Feature Documenter

Name: Automated Feature Documenter
Author: atournayre

byatournayre

0•

Learning & Documentation

Automatically generates and synchronizes feature-level documentation and README updates based on your current Git branch and code changes.

The Documenter:Update skill streamlines the technical writing process by analyzing Git branches, commit history, and code diffs to produce structured Markdown documentation. It automatically detects your project's documentation directory, creates comprehensive guides for new features, and ensures the main README stays synchronized. By implementing bidirectional linking between related documents and validating internal links, it prevents orphaned documentation and maintains a cohesive knowledge base for your codebase, allowing developers to focus on implementation while maintaining high-quality docs.

Key Features

01Automatic synchronization of the main project README with new feature details

02Structured Markdown creation including architecture, usage examples, and test validations

03Intelligent bidirectional linking to prevent orphaned documentation files

040 GitHub stars

05Context-aware documentation generation from Git branch and commit history

06Automated detection and setup of project documentation directories like /docs or /documentation

Use Cases

01Generating comprehensive technical documentation for a newly completed feature branch before merging

02Keeping the project README up-to-date with high-level summaries of recent architectural changes

03Building a structured documentation library with interlinked guides for large, complex repositories

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add atournayre/claude-personas update

For use in Claude.ai and ChatGPT