Profile My skills Saved My plugins Edit profile Submit a skill

Documentation

Provides documentation standards for README files, API references, code comments, changelogs, architecture docs, and project cleanup guidelines. Use when writing documentation, creating README files, documenting APIs, adding code comments, maintaining changelogs, or cleaning up project files.

tomevault-io Updated
Docs & Writing

File contents

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)

Converted and distributed by TomeVault — claim your Tome and manage your conversions.

tomevault-io/skills-registry/tree/main/kcenon--claude-config--documentation commit 4d66399ee1

Browse category

Frequently asked questions

npx skillmds@latest add tomevault-io/documentation-43