technical-documentation

Name: technical-documentation
Author: itsyashvardhan

Write, edit, and structure technical documentation. Use for README files, API docs, architecture docs, runbooks, setup guides, developer guides, release notes, migration guides, troubleshooting docs,

by itsyashvardhan(0) 0 installs

Free

Free account. Installing gives you the manifest plus copy-paste snippets.

See reviews

About

Imported from itsyashvardhan/skills (skills/technical-documentation/SKILL.md). Install upstream with npx skills add itsyashvardhan/skills --skill technical-documentation. Copyright stays with the author.

Technical Documentation

Create documentation that helps a real operator, developer, or stakeholder complete a task.

Workflow

Identify the reader, prerequisite knowledge, and job-to-be-done.
Inspect the implementation, commands, schemas, or product behavior before documenting it.
Prefer task-oriented structure: overview, prerequisites, steps, validation, troubleshooting.
Include exact commands, paths, configuration keys, and expected outputs when useful.
Separate confirmed facts from assumptions or TODOs.
Keep docs maintainable: avoid duplicating source-of-truth content unnecessarily.

Style

Be concise and specific.
Use examples for ambiguous APIs or workflows.
Put warnings near the risky step, not in a detached section.

Use it

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

# after Install: the listing is in your workspace's routing pool - a plan picks it for its slot
curl -s -X POST https://api.opensmartroute.ai/api/v1/route -H 'Authorization: Bearer $OSR_API_KEY' -H 'Content-Type: application/json' -d '{"text": "...", "plan": true}'

Manifest

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

itsyashvardhan-skills-technical-documentation.ocm.jsonjson

{
  "ocm": "1",
  "id": "itsyashvardhan-skills-technical-documentation",
  "kind": "skill",
  "name": "technical-documentation",
  "description": "Write, edit, and structure technical documentation. Use for README files, API docs, architecture docs, runbooks, setup guides, developer guides, release notes, migration guides, troubleshooting docs, and documentation generated from code or product behavior.",
  "publisher": "itsyashvardhan",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "coding"
    ],
    "tags": [
      "skill-md",
      "github"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Write, edit, and structure technical documentation. Use for README files, API docs, architecture docs, runbooks, setup guides, developer guides, release notes, migration guides, troubleshooting docs, and documentation generated from code or product behavior."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "github",
      "repository": "https://github.com/itsyashvardhan/skills",
      "path": "skills/technical-documentation/SKILL.md",
      "ref": "4854fe4b7df6d58fadc37bb25a169d5633712987",
      "url": "https://github.com/itsyashvardhan/skills/blob/4854fe4b7df6d58fadc37bb25a169d5633712987/skills/technical-documentation/SKILL.md",
      "key": "itsyashvardhan/skills/skills/technical-documentation/SKILL.md"
    }
  },
  "instructions": "# Technical Documentation\n\nCreate documentation that helps a real operator, developer, or stakeholder complete a task.\n\n## Workflow\n\n1. Identify the reader, prerequisite knowledge, and job-to-be-done.\n2. Inspect the implementation, commands, schemas, or product behavior before documenting it.\n3. Prefer task-oriented structure: overview, prerequisites, steps, validation, troubleshooting.\n4. Include exact commands, paths, configuration keys, and expected outputs when useful.\n5. Separate confirmed facts from assumptions or TODOs.\n6. Keep docs maintainable: avoid duplicating source-of-truth conten",
  "cost": {
    "context_tokens": 191
  }
}

Fetch it by URL: GET /api/v1/registry/itsyashvardhan-skills-technical-documentation/manifest?version=1.0.0