Home / nitinjain999 / platform-skills · GitHub

document SKILL.md skillA

document from nitinjain999/platform-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add nitinjain999/platform-skills/document@git:20261011.e8166a5

Pins git:20261011.e8166a5 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
nitinjain999/platform-skills
Path
skills/document/SKILL.md
Versions recorded
1
Latest version
git:20261011.e8166a5, committed Oct 11, 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

The exact contents, by fingerprint
mdr add nitinjain999/platform-skills/document@sha256:628add7220a02cee

The line at the top of this page pins the label git:20261011.e8166a5, 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.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_auu64oavrahzfaoo.svg)](https://markdownregistry.com/a/art_auu64oavrahzfaoo)

3 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 1 version of this file, committed on Oct 11, 2026.

versioncommittedcommitsizeaudit
git:20261011.e8166a5 latest2026-10-11 e8166a5 3,594 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • 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

GitHub

nitinjain999/platform-skills · 70 stars · license Apache-2.0 · pushed 2026-10-20 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_auu64oavrahzfaoo
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

keda Cursor rule
nitinjain999/platform-skills · .cursor/rules/keda.mdc · KEDA ScaledObject and ScaledJob generation rules — auth patterns, scaling safety, best practices
git:20260516.afdf992 · audit A · 70 stars
kubernetes Cursor rule
nitinjain999/platform-skills · .cursor/rules/kubernetes.mdc · Kubernetes and OpenShift workload generation rules — security defaults, resource limits, probes
git:20261011.38d4a57 · audit A · 70 stars
platform-skills Cursor rule
nitinjain999/platform-skills · .cursor/rules/platform-skills.mdc · Platform engineering rules — applies to all files in this workspace
git:20260926.20dcf68 · audit A · 70 stars
terraform Cursor rule
nitinjain999/platform-skills · .cursor/rules/terraform.mdc · Terraform module and resource generation rules — blast radius, IAM least privilege, SOC 2 defaults
git:20260516.215750b · audit A · 70 stars
.cursorrules Cursor rule
nitinjain999/platform-skills · .cursorrules
git:20260926.20dcf68 · audit A · 70 stars
code-review SKILL.md skill
nitinjain999/platform-skills · .github/skills/code-review/SKILL.md · Review pull requests to this repo (a Claude Code / Copilot / Cursor platform-engineering skill plugin) for technical…
git:20261017.2bd2bff · audit A · 70 stars
CLAUDE.md CLAUDE.md file
nitinjain999/platform-skills · CLAUDE.md
git:20260927.869b173 · audit A · 70 stars
platform-skills SKILL.md skill
nitinjain999/platform-skills · SKILL.md · Use when troubleshooting, implementing, reviewing, or auditing platform infrastructure as a system — where Kubernetes…
git:20260927.df75e5b · audit A · 70 stars
ai-governance SKILL.md skill
nitinjain999/platform-skills · plugins/platform-skills/skills/ai-governance/SKILL.md · Generate and enforce policy gates for AI coding agents (Copilot, Claude Code) — real-time session hooks that deny…
git:20261018.5f00d39 · audit A · 70 stars
awesome-docs SKILL.md skill
nitinjain999/platform-skills · plugins/platform-skills/skills/awesome-docs/SKILL.md · Generate, convert, and maintain animated GitHub-safe Markdown documents with animated SVG diagrams. Covers four SVG…
git:20261018.90b97a9 · audit A · 70 stars
aws-profile SKILL.md skill
nitinjain999/platform-skills · plugins/platform-skills/skills/aws-profile/SKILL.md · AWS profile management for MCP servers — discover profiles across SSO, Granted, and assumed-role chains, check…
git:20261018.90b97a9 · audit B · 70 stars
aws SKILL.md skill
nitinjain999/platform-skills · plugins/platform-skills/skills/aws/SKILL.md · Structured guidance for AWS CloudFront distributions, WAF web ACLs, Lambda@Edge, CloudFront Functions, Firewall Manager…
git:20261018.90b97a9 · audit A · 70 stars

Every file in nitinjain999/platform-skills

Other files named document

document SKILL.md skill
oliver-kriska/claude-elixir-phoenix · plugins/elixir-phoenix/skills/document/SKILL.md · Use when asked to document Elixir code: add or fill in @moduledoc and @doc for modules and functions. Documents tested…
git:20260929.c08ad14 · audit A · 569 stars
document SKILL.md skill
serpro69/claude-toolbox · kodex-plugin/skills/document/SKILL.md · After implementing a new feature or fixing a bug, make sure to document the changes. Use when writing documentation…
git:20260930.85f9f82 · audit A · 151 stars
document SKILL.md skill
serpro69/claude-toolbox · klaude-plugin/skills/document/SKILL.md · After implementing a new feature or fixing a bug, make sure to document the changes. Use when writing documentation…
git:20260930.86c5e44 · audit A · 151 stars
document SKILL.md skill
archcore-ai/archcore · plugins/archcore/skills/document/SKILL.md · Record a decision, document existing code, or file a supplied research material, in free text; no first word is a mode…
git:20261016.6aafe90 · audit A · 71 stars
document SKILL.md skill
archcore-ai/plugin · plugins/archcore/skills/document/SKILL.md · Record a decision, document existing code, or file a supplied research material, in free text; no first word is a mode…
git:20261016.6aafe90 · audit A · 71 stars
document SKILL.md skill
nitinjain999/platform-skills · plugins/platform-skills/skills/document/SKILL.md · Generate, format, and validate code documentation — docstrings, JSDoc, OpenAPI/Swagger specs, documentation sites, and…
git:20261018.90b97a9 · audit A · 70 stars
document SKILL.md skill
bdsqqq/dots · modules/agents/skills/document/SKILL.md · apply documentation philosophy — explain why, not what. use for jsdocs, READMEs, inline comments.
git:20260825.12ce506 · audit A · 64 stars
document SKILL.md skill
awrshift/agent-memory-kit · plugins/memory-kit/skills/document/SKILL.md · Write the human-facing prose about a change — PR body · changelog entry · release note · postmortem — and put it in the…
git:20261022.df602ef · audit A · 34 stars

Browse by kind, by grade A, or by owner.