agentsclimarketplace

Code documentation

Skill plaited/development-skills/skills/code-documentation

Make AI coding agents smarter. Type-aware code search, documentation standards, development conventions. CLI + installable skills for Claude, Cursor, Copilot.

Install
npx -y skills add plaited/development-skills --skill code-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

  • 1 stars1 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

TSDoc standards for TypeScript/JavaScript code. Automatically invoked when writing, reviewing, or editing any TSDoc comments, code documentation, or API documentation. (project)

The file declares its own license as ISC. That is the author’s claim about this one file, and it is not the same thing as the license GitHub reports for the repository, which is listed with the other numbers below.

SKILL.md

2.2 KB, 421 tokens by cl100k_base, as published. Nobody here has run it

Code Documentation Skill

Purpose

This skill provides TSDoc format templates, type documentation guidelines, and maintenance workflows. Use this when:

  • Writing or editing TSDoc comments for any function, type, or module
  • Reviewing documentation quality
  • Creating comprehensive API documentation
  • Documenting complex type structures
  • Cleaning up non-compliant comments (performance notes, timestamps, inline explanations)
  • Synchronizing out-of-sync TSDoc with code changes
  • Removing orphaned documentation for deleted code

Key Standard: No @example sections - tests and stories serve as living examples.

Quick Reference

  • Creating TSDoc: See workflow.md for the generation workflow
  • Maintaining TSDoc: See maintenance.md for cleanup and sync guidelines

This skill contains detailed templates for:

  • Public API Functions
  • Internal Module Documentation
  • Public and Internal Types
  • Helper Functions
  • Behavioral Programming Functions
  • Special Annotations (Security, Performance, Deprecated)
  • Type Documentation (Complex Objects, Unions, Functions, Utilities, Branded Types, etc.)

Navigation

Related Skills

  • typescript-lsp: Use for type verification and discovery during documentation workflow. Essential for Phase 1 (type analysis) and Phase 2 (usage discovery) of the TSDoc generation process. Run lsp-hover to verify signatures, lsp-references to find usages, and lsp-symbols to understand file structure.

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.