document SKILL.md skillA
This file is byte-identical to the first copy the registry indexed. Same content hash, so the same checks give both the same grade.
document from nitinjain999/platform-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add nitinjain999/platform-skills/document@git:20261018.90b97a9Pins git:20261018.90b97a9 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- nitinjain999/platform-skills
- Path
plugins/platform-skills/skills/document/SKILL.md- Versions recorded
- 1
- Latest version
- git:20261018.90b97a9, committed Oct 18, 2026
- Size
- 3,594 bytes
- Repository stars
- 70
- License
- Apache-2.0
Generate, format, and validate code documentation — docstrings, JSDoc, OpenAPI/Swagger specs, documentation sites, and developer guides.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
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 …
Read the whole file at its exact version.
How to install
mdr add nitinjain999/platform-skills/document@sha256:628add7220a02ceeThe line at the top of this page pins the label git:20261018.90b97a9, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_xgdxihppjwbuai5b)
1 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Oct 18, 2026.
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (3594 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
nitinjain999/platform-skills · 70 stars · license Apache-2.0 · pushed 2026-10-20 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_xgdxihppjwbuai5b GET https://markdownregistry.com/api/v1/resolve?ref=nitinjain999/platform-skills/document GET https://markdownregistry.com/api/v1/blob/628add7220a02cee6858a92d219fbb4a2db51799b73e4b7bf7fdcc40bf2e97ca
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from nitinjain999/platform-skills
Every file in nitinjain999/platform-skills