update-docs

Update design docs, implementation plans, API comparisons, and tutorials after feature completion.

19|Updated Dec 29, 2025
One-click install
npx skills add https://github.com/watany-dev/kantan-ui --skill update-docs-watany-dev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/watany-dev/kantan-ui/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/watany-dev/kantan-ui --skill update-docs-watany-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the synchronization of project documentation after feature completion, reducing manual drift and ensuring consistency across docs.

Core Features & Use Cases

  • Update Design Documents (docs/design/<feature>.md) with status blocks, API specifications, and Streamlit comparisons.
  • Update Implementation Plans (docs/impl/<feature>.md) with iteration progress and file mappings.
  • Update API Comparison Table (docs/streamlit-api-comparison.md) to reflect implemented APIs.
  • Refresh English README.md and Tutorial docs (docs/TUTORIAL.md) as needed during release cycles.

Quick Start

Run the update-docs workflow to refresh all project documentation after completing feature work.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I automatically update project documentation after implementing a feature?

To automatically update project documentation after feature implementation, run a templated workflow that refreshes design documents, implementation plans, API comparisons, README, and tutorials to reflect the latest repository changes.

What is the best way to keep design documents and implementation plans consistent after code changes?

Keeping design documents and implementation plans consistent requires enforcing templated workflows that automatically inject status blocks, API specifications, and iteration progress into your docs immediately after code changes are merged.

How do I refresh an API comparison table when new APIs are implemented?

To refresh an API comparison table when new APIs are implemented, use an automated documentation workflow that updates the Streamlit API comparison file to accurately reflect the newly implemented endpoints and specifications.

Can I synchronize my README and tutorial docs during release cycles without manual editing?

Yes, you can synchronize your English README and tutorial docs during release cycles without manual editing by running an automated documentation workflow that refreshes these files as needed to match the latest project state.

Does automated documentation synchronization work with versioning and templated workflows?

Automated documentation synchronization works directly with versioning and templated workflows by enforcing standardized status updates and file mappings across design documents, implementation plans, and tutorials to ensure version consistency.

What should I do if my project documentation starts drifting from the actual implementation?

If your project documentation starts drifting from the actual implementation, run an automated documentation update workflow to synchronize design documents, implementation plans, and API comparisons with the latest codebase changes.