Will it modify my internal design documents?

No, the skill is configured to treat internal design docs as read-only sources of intent, focusing its edits only on implementation-facing documentation like READMEs and guides.

Does it support non-English documentation?

Yes, it specifically manages synchronization between English (.md) and Japanese (.ja.md) files to ensure they stay consistent.

Can it run automated tests on my documentation?

Yes, it is designed to use tools like Deno to run tasks such as 'verify-docs' and 'generate-docs-manifest' to ensure formatting and versions are correct.

How does the skill detect documentation gaps?

It uses a structured process of reading internal design specs and surveying actual code implementation to build a diff table against current documentation files.

Documentation Consistency Assistant

Name: Documentation Consistency Assistant
Author: tettuan

bytettuan

0•

Content Management

Synchronizes documentation with code implementation through automated analysis and structured verification workflows.

The Docs Consistency skill ensures your project documentation never falls out of sync with the actual implementation. It follows a rigorous multi-phase process: extracting original design intent from internal records, surveying the codebase for API changes and edge cases, and performing a detailed gap analysis against existing docs. It automatically updates READMEs, guides, and help outputs while supporting multilingual synchronization (English and Japanese). By integrating with local verification tasks, it guarantees that your documentation remains a reliable source of truth for users and developers alike.

Key Features

01Automated gap analysis between implementation and documentation

02Structured intent extraction from internal design documents

03Integration with automated verification tasks (Deno)

04Smart lifecycle management for temporary design memos

050 GitHub stars

06Multilingual synchronization for English and Japanese documentation

Use Cases

01Updating READMEs and guides after major feature releases or code refactors

02Verifying CLI help output against current implementation logic

03Maintaining parity between primary English docs and Japanese translations

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add tettuan/climpt docs-consistency

For use in Claude.ai and ChatGPT

Download Skill