skills.rest
ViperJuice
ViperJuiceCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

post-impl-docs

Update README, CHANGELOG, docs/, and docstrings from code diffs.

8|1|Updated Jul 11, 2025
Search Tags:#automation#workflow#documentation#docstrings#docs#README#CHANGELOG
One-click install
npx skills add https://github.com/ViperJuice/treesitter-chunker --skill post-impl-docs-viperjuice
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: post-impl-docs
Source: https://github.com/ViperJuice/treesitter-chunker/tree/main/.ai-dev-kit/skills/post-impl-docs
Command: npx skills add https://github.com/ViperJuice/treesitter-chunker --skill post-impl-docs-viperjuice

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps repository documentation in sync with implemented code by updating README, CHANGELOG, docs/, and inline docstrings after code changes, reducing drift and manual effort.

Core Features & Use Cases

  • Automates synchronization of documentation across README, CHANGELOG, docs/, and inline docstrings following feature implementations.
  • Detects documentation impact from code changes and applies updates to relevant files to reflect new APIs and behavior.
  • Use Case: After implementing a feature, run this skill to automatically refresh docs and ensure consistency before release.

Quick Start

Execute post-implementation documentation updates to align the project docs with the latest code.

Frequently Asked Questions about post-impl-docs

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

FAQPage Schema
How do I automate documentation updates after code changes?▼

You can automate documentation updates by analyzing code diffs to detect documentation impact, then applying necessary updates to README, CHANGELOG, docs/, and inline docstrings to reflect new APIs and behavior.

What is the best way to keep my README and CHANGELOG in sync with implemented features?▼

The best way to keep README and CHANGELOG in sync is to run an automated workflow that detects documentation impact from code changes and applies updates to relevant files, ensuring consistency before release.

Can I automatically update inline docstrings when my API behavior changes?▼

Yes, you can automatically update inline docstrings. The automation analyzes code diffs to identify changes in API behavior and applies the necessary updates to inline docstrings alongside public-facing docs.

How does automated documentation synchronization handle code diff analysis?▼

Automated documentation synchronization handles code diff analysis by evaluating the implemented changes, determining the documentation impact, and applying updates across README, CHANGELOG, and docs/ directories to reduce manual effort.

Do I need a specific workflow executor to prepare documentation changes for commit?▼

You need a lane-executor workflow to prepare documentation changes for commit. The automation applies the necessary updates and ensures changes are ready for commit through these specific workflows.

Related Skills

Explore More Content & Communication Skills→
kettleofketchupkettleofketchup

documentation-reviewer

Analyze git diffs to identify required MkDocs documentation changes.

Community
Intermediate
frostantfrostant
42

changelog-generator

Converts git commit history into categorized, ready-to-publish markdown release notes.

Community
Intermediate
RichardGeorgeDavisRichardGeorgeDavis
2

typescript-review

Analyze TypeScript changes for typing accuracy, runtime behavior, and contract adherence.

Community
Intermediate
windyskywindysky

moai-docs-generation

Generate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Advanced