About

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

Docs Writer

Name: docs
Author: shipshitdev

Write documentation that matches existing repo conventions.

When to Use

Writing or updating README, guides, runbooks, or onboarding docs
Creating API references, setup instructions, or troubleshooting notes

Workflow

Clarify audience and goal.
Find existing docs and follow their structure, tone, and terminology.
Outline with clear headings (Overview, Prereqs, Steps, Reference, Troubleshooting).
Prefer concrete steps, examples, and copy-pasteable commands.
Keep it current: reference actual paths and scripts in the repo.
Note assumptions and open questions.

Style

Short sentences and bullets.
Use code blocks for commands and configuration.
Avoid marketing language unless explicitly requested.
Ensure steps are ordered and verifiable.

Quality Checklist

Matches repo patterns and terminology
Clear prerequisites and environment requirements
Steps are sequential and actionable
Examples compile/run as written
No dead links or stale paths

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/shipshitdev-skills-docs/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.

shipshitdev-skills-docs.ocm.jsonjson

{
  "ocm": "1",
  "id": "shipshitdev-skills-docs",
  "kind": "skill",
  "name": "docs",
  "description": "Creates clear, concise technical documentation for software projects, runbooks, and developer guides. Use when writing or updating a README, guide, runbook, API reference, setup instructions, or troubleshooting notes.",
  "publisher": "shipshitdev",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "coding"
    ],
    "tags": [
      "skill-md",
      "documentation",
      "technical-writing",
      "runbooks",
      "skills-sh"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Creates clear, concise technical documentation for software projects, runbooks, and developer guides. Use when writing or updating a README, guide, runbook, API reference, setup instructions, or troubleshooting notes."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "skills.sh",
      "repository": "https://github.com/shipshitdev/skills",
      "path": "skills/docs/SKILL.md",
      "ref": "HEAD",
      "url": "https://github.com/shipshitdev/skills/blob/HEAD/skills/docs/SKILL.md",
      "key": "shipshitdev/skills/skills/docs/SKILL.md"
    }
  },
  "instructions": "# Docs Writer\n\nWrite documentation that matches existing repo conventions.\n\n## When to Use\n\n- Writing or updating README, guides, runbooks, or onboarding docs\n- Creating API references, setup instructions, or troubleshooting notes\n\n## Workflow\n\n1) Clarify audience and goal.\n2) Find existing docs and follow their structure, tone, and terminology.\n3) Outline with clear headings (Overview, Prereqs, Steps, Reference, Troubleshooting).\n4) Prefer concrete steps, examples, and copy-pasteable commands.\n5) Keep it current: reference actual paths and scripts in the repo.\n6) Note assumptions and open que",
  "cost": {
    "context_tokens": 253
  }
}

Fetch it by URL: GET /api/v1/registry/shipshitdev-skills-docs/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.