Tsdoc Jsdoc Authoring
CheckedAutomatically generates comprehensive documentation (TsDoc & JSDoc) from your code, streamlining developer workflows and improving project maintainability.
Install on your platform
Showing Claude Code. One command installs this skill into any of the agents below.
- 1
Run this in your project
terminal$ npx skills add inthhq/agent-skills --skill tsdoc-jsdoc-authoring -a claude-code Uses the open-source
skillsCLI and needs Node.js. Add-gto install it for your user instead of this project.
What we know about this skill
Publisher
consentdotio
Taken from the source listing. We haven't verified who controls this account.
Install target
Live repository
Not pinned. Installing fetches whatever the repository holds at the time you run the command.
Automated safety checks
This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.
Declares what it does: passed
SKILL.md parses and declares a name and a description.
SKILL.md exists, its frontmatter parses, and it declares a name and a description.
No undeclared network calls: passed
Makes no network calls.
Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.
No obfuscated payloads: passed
No encoded or obfuscated payloads.
No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.
No credential access: passed
Reads no keys, tokens, keychains or credential files.
Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.
No pipe-to-shell installers: passed
No pipe-to-shell or download-and-run installers.
No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.
Pinned to a commit: passed
Scanned consentdotio/agent-skills at ffcbc99bc3.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- ffcbc99bc3
- Manifest
- tsdoc-jsdoc-authoring/SKILL.md
- Scanned
- 49 files, 2,063 lines
About this skill
What it does
This skill allows AI agents to generate JSDoc comments for TypeScript code. It understands existing code and produces structured documentation blocks, improving code maintainability and developer understanding. The generated documentation adheres to the JSDoc standard, making it compatible with various documentation generators.
When to use it
- Automating Documentation: Generate initial JSDoc stubs for a new TypeScript project or codebase.
- Refactoring Existing Code: Quickly add missing JSDoc comments during code refactoring efforts.
- Improving Code Readability: Create clear and concise documentation directly within the source code, enhancing understanding for other developers (or yourself later!).
- Generating API Documentation: Produce a foundation for automated API documentation generation tools.
Key capabilities
- Generates JSDoc comments
- Supports TypeScript code
- Adheres to JSDoc standard
- Understands existing code context
Example prompts
- "Generate JSDoc for this function:
function calculateSum(a, b) { return a + b; }" - "Add JSDoc comments to all functions in this file."
- “Create JSDoc documentation explaining the purpose of this class.”
Tips & gotchas
The skill requires access to the TypeScript code you want documented. Ensure the AI agent has appropriate permissions and context to analyze the codebase effectively.