agentsclimarketplace

Add documentation

Skill emaraschio/cursor-commands/plugin/.cursor/skill-contracts/add-documentation

Production-grade Cursor slash commands with paired skill contracts, behavioral evals, and ship-gate CI. Install as a user plugin.

Install
npx -y skills add emaraschio/cursor-commands --skill add-documentation

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

  • 9 stars9 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

Add or improve code documentation for the current change

SKILL.md

1.6 KB, as published. Nobody here has run it

Overview

Add comprehensive documentation for the current code/feature and format it according to the project's documentation standards, including it in the appropriate location (README, docs folder, or inline comments).

Steps

  1. Overview
    • What this code/feature does
    • Why it exists and its purpose
    • Key concepts and terminology
  2. API Documentation
    • Function/method signatures
    • Parameters and return values
    • Example usage with code snippets
    • Error handling and edge cases
  3. Implementation Details
    • Architecture overview
    • Important design decisions
    • Dependencies and integrations
  4. Examples
    • Common use cases with full examples
    • Best practices and patterns
    • Common pitfalls to avoid

Add Documentation Checklist

  • Explained what this code/feature does
  • Documented why it exists and its purpose
  • Defined key concepts and terminology
  • Documented function/method signatures
  • Documented parameters and return values
  • Included example usage with code snippets
  • Documented error handling and edge cases
  • Provided architecture overview
  • Documented important design decisions
  • Included common use cases with full examples
  • Documented best practices and patterns
  • Documented common pitfalls to avoid

Guardrails

  • Document intent, contracts, and edge cases; do not document obvious one-liners.
  • Match the project's existing documentation style and location.

Keep looking

Skills are one crate of 328,083. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.