agentmods.dev

document

document is a skill for Claude Code from nitinjain999/platform-skills. It costs 31 tokens per session (852 once invoked), scanned A, original, Apache-2.0.

A code-documentation tool for writing and checking docstrings, JSDoc, API specifications, documentation sites, and developer guides. OpenAPI is a standard description of how a web API works.

In plain words
What is it for?
Use it to add Python or JavaScript documentation, create OpenAPI 3.1 specifications, validate examples, and measure documentation coverage.
Why use it?
It helps keep explanations of code and API endpoints accurate, complete, and checked against the implementation. It also reduces undocumented public functions and invalid examples.

Skill for Claude Code

Written for Claude Code: argument-hint in frontmatter.

Part of the platform-skills plugin — 50 skills, 1 agent shipped together

not rated 70repo +2 3d ago A scan 31 tokens original Apache-2.0

Good fit Use it to add Python or JavaScript documentation, create OpenAPI 3.1 specifications, validate examples, and measure documentation coverage.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/nitinjain999/platform-skills/document
View source ↗ nitinjain999/platform-skills
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add nitinjain999/platform-skills --skill document
Clone the repo
git clone --depth 1 https://github.com/nitinjain999/platform-skills

Made for: Claude Code.

Or install platform-skills, the plugin that ships this one along with the rest of its 50 skills, 1 agent.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for document

README.md
[![agentmods](https://agentmods.dev/badge/skills/nitinjain999/platform-skills/document/github.svg)](https://agentmods.dev/skills/nitinjain999/platform-skills/document)
Your own site
<a href="https://agentmods.dev/skills/nitinjain999/platform-skills/document"><img src="https://agentmods.dev/badge/skills/nitinjain999/platform-skills/document/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for document

Your own site · 80×15
<a href="https://agentmods.dev/skills/nitinjain999/platform-skills/document"><img src="https://agentmods.dev/badge/skills/nitinjain999/platform-skills/document.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 31 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 852 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00031 $0.00852
Opus 5.5 $0.00012 $0.00341
Sonnet 5.5 $0.00006 $0.00170
Haiku 4.5 $0.00003 $0.00085

Measured 5d ago against content hash 628add7220a0, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

document scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 5d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/document/SKILL.md · 87 lines

How it starts

The opening of the file, as written. The whole thing — 87 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Generate or improve technical documentation for a codebase or API.

Mode: docstrings

Add or improve inline documentation for functions, classes, and modules.

Steps:

  1. Ask for: language, preferred style (Google / NumPy / Sphinx for Python; JSDoc for TypeScript/JavaScript)
  2. Identify all public functions and classes missing documentation
  3. For each, document: purpose, all parameters with types, return value, exceptions raised, and at least one example
  4. Validate examples compile and run:
    • Python: python -m doctest file.py or pytest --doctest-modules
    • TypeScript: tsc --noEmit
  5. Generate coverage report: interrogate --fail-under=80 src/ (Python) or npx typedoc-coverage (TypeScript)

Rules:

  • Do NOT document obvious getters/setters verbosely
  • Do NOT repeat the function signature in prose
  • Do NOT document private/internal methods unless they have complex invariants

Reference: references/documentation.md → Python Docstrings, TypeScript JSDoc

Mode: openapi

Generate or improve an OpenAPI 3.1 specification for a REST API.

Steps:

  1. Ask for: framework (FastAPI / Django / NestJS / Express / raw spec), existing routes or codebase to analyse
  2. Map all endpoints: method, path, request body schema, response schemas per status code
  3. Extract shared schemas into components/schemas
  4. Extract shared responses (400, 401, 404, 500) into components/responses
  5. Add operationId for every operation
  6. Add security scheme and apply globally or per-operation
  7. Validate: npx @redocly/cli lint openapi.yaml
  8. Generate HTML preview: npx @redocly/cli build-docs openapi.yaml

For FastAPI: document with Pydantic model Field(description=...) and docstrings on route functions — auto-generates /docs. For NestJS: use @ApiProperty, @ApiOperation, @ApiResponse decorators.

Reference: references/documentation.md → OpenAPI 3.1, FastAPI, NestJS

Mode: site

Set up a documentation site for a project.

Steps:

  1. Ask for: project type (Python library / TypeScript SDK / REST API / platform runbook)
  2. Recommend appropriate generator:
    • Python projects → MkDocs + mkdocstrings + Material theme
    • TypeScript projects → TypeDoc + typedoc-material-theme
    • API portals → Redocly or Stoplight
    • General docs → Docusaurus
  3. Generate site configuration file
  4. Define nav structure: Getting Started, API Reference, Guides, Changelog
  5. Wire docstring auto-generation from source code
  6. Add search plugin
  7. Provide serve and build commands

Read the full file on GitHub · 87 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 5d ago First seen · 87 lines · 31 tokens per session scan A 628add7220a0

Subscribe to this mod's changes

document is a skill published in the GitHub repository nitinjain999/platform-skills (70 stars, last pushed 3d ago), licensed Apache-2.0. It adds 31 tokens to every session and 852 once invoked, about $0.0001 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-10-12.

Backend and APIsDevOps and cloudWriting and docsai-toolsclaude-code-plugincopilot-coding-agentgrafanakubernetes
Related

Other skills, from other repositories

python-services

Python patterns for CLI tools, async parallelism, and backend services. Use when building CLI apps, async/parallel Python, FastAPI services, background jobs, or configuring Python project tooling (uv, ruff, ty).

iliaal/whetstone · 48 tokens

nodejs-backend

Node.js backend patterns: framework selection, layered architecture, TypeScript, validation, error handling, security, production deployment. Use when building REST APIs, Express/Fastify servers, microservices, or server-side TypeScript.

iliaal/whetstone · 50 tokens

ia-php-laravel

Modern PHP 8.4 and Laravel patterns: architecture, Eloquent, migrations, queues, testing. Use when working with Laravel, Eloquent, Blade, artisan, or building/testing a framework-based PHP app. Not for php-src internals, standalone PHP libraries, or general PHP language discussion.

iliaal/whetstone · 67 tokens

php-laravel

Modern PHP 8.2+ and Laravel patterns: architecture, Eloquent, queues, Pest testing. Use when asked to "write PHP", "build a Laravel app", "fix Eloquent query", "add a queue job", "write a Pest test", or mentions PHP, Laravel, Eloquent, Blade, artisan, or migrations.

iliaal/whetstone · 74 tokens

architect

This skill should be used when the user asks to "design system architecture", "evaluate microservices vs monolith", "create architecture diagrams", "analyze dependencies", "choose a database", "plan for scalability", "make technical decisions", or "review system design".

Joncik91/ucai · 56 tokens

backend

This skill should be used when the user asks to "design REST APIs", "optimize database queries", "implement authentication", "build microservices", "review backend code", "set up GraphQL", "handle database migrations", or "load test APIs".

Joncik91/ucai · 54 tokens