🔍 Code Documentation
TSDoc standards for TypeScript/JavaScript code. Automatically invoked when writing, reviewing, or editing any TSDoc comments, code documentation, or API documentation. (project)
npx playbooks add skill plaited/agent-eval-harness --skill code-documentation
About Code Documentation
Code Documentation specializes your AI coding agent in code review & quality — it tsdoc standards for typescript/javascript code. automatically invoked when writing, reviewing, or editing any tsdoc comments, code documentation, or api documentation. (project).
At 21 words, this compact prompt gives your agent specialized code review & quality expertise with structured patterns and output formats. Install via CLI or copy the prompt below.
Use Cases
- Catching bugs and security vulnerabilities before merge
- Enforcing code style and architectural consistency
- Reviewing PRs for performance and maintainability
- Generating detailed code review comments
Example Prompts
System Prompt (21 words)
TSDoc standards for TypeScript/JavaScript code. Automatically invoked when writing, reviewing, or editing any TSDoc comments, code documentation, or API documentation. (project)
Frequently Asked Questions
What is Code Documentation?
Code Documentation is a free code review & quality skill for AI coding agents. TSDoc standards for TypeScript/JavaScript code. Automatically invoked when writing, reviewing, or editing any TSDoc comments, code documentation, or API documentation. (project). It provides a specialized system prompt that configures your agent with code review & quality expertise.
How do I use Code Documentation with Claude Code?
Run npx playbooks add skill plaited/agent-eval-harness --skill code-documentation in your terminal to install Code Documentation into your Claude Code session. It works immediately after installation.
Which AI coding agents work with Code Documentation?
Code Documentation is compatible with Claude Code, Cursor, GitHub Copilot, Windsurf, OpenClaw, Cline, and any AI agent that supports custom system prompts or .cursorrules files.
Is Code Documentation free to use?
Yes, Code Documentation is completely free and open source. The full source is available on GitHub at https://github.com/plaited/agent-eval-harness/tree/main/.agents/skills/code-documentation. You only need a subscription to the AI agent you use it with.
