skills.rest
Consiliency
ConsiliencyOFFICIAL
Explore all skills by this author →
WebsiteGitHub

post-impl-docs

Update README.md, CHANGELOG.md, docs/, and docstrings after code changes.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps repository documentation in sync with code changes after implementation.

Core Features & Use Cases

  • Automatically refresh README.md with new features and APIs after code is implemented.
  • Update CHANGELOG.md with change summaries and new entries in the project's preferred format.
  • Synchronize docs/ references and inline docstrings to reflect code changes.
  • Triggered by lane-executor after task completion to ensure docs stay in sync.

Quick Start

To start, run the post-impl-docs skill after implementing code changes to refresh docs.

Frequently Asked Questions about post-impl-docs

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

FAQPage Schema
How do I keep documentation in sync after implementing code changes?▼

Documentation stays in sync by running post-impl-docs after code changes to automatically refresh README.md, CHANGELOG.md, docs/, and docstrings. The skill analyzes your changes, formats documents to project standards, and commits updates in one workflow.

Can I automate README and CHANGELOG updates when adding new features?▼

Yes. Post-impl-docs automatically updates README.md with new features and APIs, and refreshes CHANGELOG.md with formatted change entries after implementation, eliminating manual doc edits.

What documentation files does this skill update?▼

The skill synchronizes README.md, CHANGELOG.md, docs/ directory files, and inline docstrings to reflect new features, APIs, and fixes introduced in your code changes.

When should I run documentation updates after coding?▼

Run post-impl-docs immediately after completing code implementation. It's typically triggered by lane-executor to ensure docs stay current with your latest features, APIs, and fixes.

Do I need to manually format CHANGELOG entries and docstrings?▼

No. Post-impl-docs automatically formats all documentation—CHANGELOG entries, docstrings, and docs—according to your project's standards, so formatting stays consistent across updates.

Does this work if my project uses multiple doc formats?▼

Yes. Post-impl-docs handles mixed formats including README.md, CHANGELOG.md, docs/ directories, and inline docstrings in a single pass, keeping all documentation synchronized with code changes.

Related Skills

Explore More Content & Communication Skills→
jiayaoqijiajiayaoqijia
98

doc-check

Analyze code diffs to identify documentation gaps and propose updates.

Community
Intermediate
chuan-khunachuan-khuna
3

manage-content

Coordinate content publishing and schema consistency across posts, notes, resume entries, nav items, and OG images.

Community
Intermediate
UnsupervisedcomUnsupervisedcom
49

commit.commit_and_push

Commit and push validated code changes after lint passes.

Official
Basic
CJ-1981CJ-1981

moai-docs-generation

Generate API and code documentation from Python and TypeScript source code.

Community
Advanced