About

Imported from stefans71/Open-Pi-Harness-Advanced-V2 (extensions/pi-skills/default-skills/document/SKILL.md). Install upstream with npx skills add stefans71/Open-Pi-Harness-Advanced-V2 --skill document. Copyright stays with the author.

Document

Name: Document
Author: stefans71

Purpose

Generate clear, concise documentation for code: inline comments, JSDoc/docstrings, README sections, or API docs.

Instructions

1. Understand the Target

Read the files or functions to document
Identify the public API surface (exports, public methods, types)
Check existing documentation style in the project

2. Write Documentation

Match the project's existing doc style (JSDoc, TSDoc, Python docstrings, etc.)
Document why, not what — the code shows what
For functions: purpose, parameters, return value, throws/errors, example if non-obvious
For modules/files: one-line summary, key exports, usage pattern
For types/interfaces: purpose and when to use, not field-by-field restating

3. Review

Verify accuracy against the actual implementation
Remove redundant docs that just restate the type signature
Ensure examples compile/run if provided

Output Format

## Documentation Added
- **Scope**: What was documented (file, module, function list)
- **Style**: Doc format used (JSDoc, docstrings, markdown, etc.)
- **Notes**: Any ambiguities found or assumptions made

Provider Notes

Ollama (local models)

Process one file at a time for large codebases
Keep doc strings concise — local models work better with shorter outputs

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/stefans71-open-pi-harness-advanced-v2-document/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

stefans71-open-pi-harness-advanced-v2-document.ocm.jsonjson

{
  "ocm": "1",
  "id": "stefans71-open-pi-harness-advanced-v2-document",
  "kind": "skill",
  "name": "Document",
  "description": "Document",
  "publisher": "stefans71",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "general"
    ],
    "tags": [
      "skill-md",
      "documentation",
      "docs",
      "comments",
      "github"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Document"
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "github",
      "repository": "https://github.com/stefans71/Open-Pi-Harness-Advanced-V2",
      "path": "extensions/pi-skills/default-skills/document/SKILL.md",
      "ref": "2b8dec006330d1e664367966e1df3bbc0ffd6684",
      "url": "https://github.com/stefans71/Open-Pi-Harness-Advanced-V2/blob/2b8dec006330d1e664367966e1df3bbc0ffd6684/extensions/pi-skills/default-skills/document/SKILL.md",
      "key": "stefans71/Open-Pi-Harness-Advanced-V2/extensions/pi-skills/default-skills/document/SKILL.md"
    }
  },
  "instructions": "# Document\n\n## Purpose\nGenerate clear, concise documentation for code: inline comments, JSDoc/docstrings, README sections, or API docs.\n\n## Instructions\n\n### 1. Understand the Target\n- Read the files or functions to document\n- Identify the public API surface (exports, public methods, types)\n- Check existing documentation style in the project\n\n### 2. Write Documentation\n- Match the project's existing doc style (JSDoc, TSDoc, Python docstrings, etc.)\n- Document **why**, not **what** — the code shows what\n- For functions: purpose, parameters, return value, throws/errors, example if non-obvious\n- ",
  "cost": {
    "context_tokens": 328
  }
}

Fetch it by URL: GET /api/v1/registry/stefans71-open-pi-harness-advanced-v2-document/manifest?version=1.0.0

Reviews

Star ratings from people who tried it. One review per account; edit yours any time.

No reviews yet. Install it, try it, and be the first to rate it.