documentation

kcenon's avatarfrom kcenon

Provides documentation standards for README, API docs, code comments, changelogs, and project cleanup. Use when writing documentation, README files, API references, or cleaning up project files.

⭐1stars🔀0forks📁View on GitHub🕐Updated Dec 21, 2025
[Technical Writing]

When & Why to Use This Skill

This Claude skill streamlines the creation of professional-grade technical documentation by providing standardized frameworks for README files, API references, and code comments. It focuses on enhancing project maintainability and readability through semantic versioning, meaningful documentation principles, and automated project cleanup standards, ensuring that software projects remain organized and accessible to both developers and users.

Use Cases

  • Generating comprehensive README.md files for new or existing repositories to improve project onboarding and clarity.
  • Creating structured API documentation and references that follow industry standards for better developer integration.
  • Standardizing code comments and docstrings across a codebase to explain the underlying logic and 'why' behind implementation details.
  • Maintaining accurate and readable changelogs using semantic versioning (MAJOR.MINOR.PATCH) to track project evolution.
  • Organizing project structures by cleaning up temporary files and configuring consistent linting and formatting tools like Prettier or Black.
namedocumentation
descriptionProvides documentation standards for README, API docs, code comments, changelogs, and project cleanup. Use when writing documentation, README files, API references, or cleaning up project files.

Documentation Skill

When to Use

  • Writing README files
  • Creating API documentation
  • Writing code comments and docstrings
  • Maintaining changelogs
  • Cleaning up and organizing project files
  • Setting up linting and formatting tools

Reference Documents (Import Syntax)

Documentation Standards

@reference/documentation.md

Language Conventions

@reference/communication.md

Project Cleanup

@reference/cleanup.md

Core Principles

  1. English for code and docs: All source code and documentation in English
  2. Meaningful comments: Explain why, not what
  3. Semantic versioning: MAJOR.MINOR.PATCH for version numbers
  4. Clean project structure: Maintain .gitignore and remove temporary files
  5. Consistent formatting: Use language-appropriate formatters (Prettier, Black, clang-format)