Doc writer

Skill rakibulism/agent-skills-os/skills/doc-writer

THE UNIVERSAL AGENT SKILLS LIBRARY

Install

npx -y skills add rakibulism/agent-skills-os --skill doc-writer

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

2 stars2 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

Generate documentation for code — API references, README sections, usage guides, inline JSDoc/docstrings. Produces clear, accurate docs targeted at the actual reader. Use when the user asks to document, write a README, add docstrings, or explain how to use a module.

SKILL.md

3.0 KB, as published. Nobody here has run it

Doc Writer

You write documentation that answers the reader's actual questions in the order they ask them.

Principles

Lead with the answer. A reader scans for "what is this and should I use it." Put that in the first paragraph.
Show, don't describe. A 3-line code example teaches more than a paragraph about the API shape.
Document the contract, not the implementation. Inputs, outputs, errors, side effects, performance characteristics — not how internals work.
Be honest about limitations. "Doesn't support X yet" is more useful than silence.
Keep examples runnable. If the reader copy-pastes the example verbatim, it should work.

Structure by doc type

README

# <Name>

<One sentence: what it is and what it does>

## Install
<one-line install command>

## Quick start
<minimal working example, ~10 lines max>

## Why
<one paragraph: what problem this solves and when to reach for it>

## Usage
<a few common scenarios, each with code>

## API
<concise reference — or link to a separate API doc>

## Limitations
<honest list of what it doesn't do>

## License

API reference

Per function/class:

Signature (with types)
What it does (one sentence)
Parameters (name, type, required?, what it controls)
Returns (type, meaning)
Throws (which errors, when)
Example (one realistic call)
Notes (gotchas, performance, related functions)

Inline (JSDoc/docstrings)

One-sentence summary on the first line.
Document parameters and return only when their meaning isn't obvious from name+type.
Document side effects, mutations, and error conditions always.
Don't repeat what the type signature already says.

What to avoid

Marketing prose. "Blazingly fast", "robust", "enterprise-grade" — cut.
Documenting the obvious. // increments counter above counter++.
Describing implementation in user docs. Save that for code comments.
Outdated examples. If the API has changed, update or delete the example — never leave a broken one.

Output format

Produce the documentation directly, formatted in the appropriate target (markdown, JSDoc, etc.). For READMEs, output the full document. For inline docs, output the annotated code.