Skills
.Work. You
Rest

documentation-completeness

Community

Keep docs fresh, onboard faster, prevent knowledge loss.

Content & Communication#changelog#documentation#onboarding#knowledge management#readme#code comments#api docs
Authortipmaster
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill ensures that code changes are always accompanied by relevant documentation updates, preventing outdated information, reducing onboarding friction for new team members, and preserving critical institutional knowledge.

Core Features & Use Cases

  • README Updates: Guides updating installation, usage, configuration, and examples in the project's README.md.
  • Code Comments: Advises on when and what to comment, focusing on why and complex logic rather than what.
  • API & Changelog Sync: Ensures API documentation (OpenAPI/JSDoc) and user-facing CHANGELOG.md are current.
  • Use Case: After implementing a new feature, use this skill to ensure the README.md is updated, relevant code comments are added, the API documentation reflects new endpoints, and the CHANGELOG.md includes the user-facing changes.

Quick Start

Use the documentation-completeness skill to review my pull request for a new feature, ensuring all relevant documentation (README, API docs, comments) has been updated.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: documentation-completeness
Download link: https://github.com/tipmaster/claude-config/archive/main.zip#documentation-completeness

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.