documentation | Skill Performance & Reviews | TopRankSkills

TopRank Skills

Home / Skills / tools / documentation

documentation

maintained by kcenon

star 2 account_tree 0 verified_user MIT License
bolt View GitHub

name: documentation description: 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.

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)

chat Comments (0)

chat_bubble_outline

No comments yet. Be the first to share your thoughts!

Skill Details

GitHub Stars 2
GitHub Forks 0
Created Jan 2026
Last Updated 5个月前
tools tools automation tools

Related Skills

specs-gen
chevron_right
pr

pr

MoonshotAI
star 6.1k
chevron_right
glm-coding-agent
chevron_right
feature-dev
chevron_right
writing-skills
chevron_right

Build your own?

Join 12,000+ developers contributing to the Claude ecosystem.