skills.rest
rakibulism
rakibulismCOMMUNITY
Explore all skills by this author →
Website𝕏@rakibulismGitHub

doc-writer

Generate READMEs, API references, usage guides, and inline docstrings for code.

2|1|Updated May 17, 2026
Search Tags:#documentation#readme#jsdoc#docstrings#usage guide#api reference
One-click install
npx skills add https://github.com/rakibulism/agent-skills-os --skill doc-writer-rakibulism
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-writer
Source: https://github.com/rakibulism/agent-skills-os/tree/main/skills/doc-writer
Command: npx skills add https://github.com/rakibulism/agent-skills-os --skill doc-writer-rakibulism

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you write documentation that answers real user questions clearly and quickly, instead of producing vague or overly technical prose.

Core Features & Use Cases

  • README writing: Create concise, useful project READMEs with install, quick start, usage, and limitations.
  • API reference drafting: Document functions, classes, parameters, returns, errors, and examples in a reader-friendly format.
  • Inline documentation: Produce accurate JSDoc or docstrings that explain behavior, side effects, and edge cases.
  • Use Case: A library maintainer can provide source code and ask for a README section or API docs that a first-time user can actually follow.

Quick Start

Ask the doc-writer skill to generate a README for the provided codebase aimed at first-time users.

Frequently Asked Questions about doc-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a README for my codebase aimed at first-time users?▼

Generate a README by providing your source code to the documentation writer, which outputs a concise project summary with install instructions, quick start usage, and stated limitations for first-time users.

Can I automatically create API references that document parameters, returns, and errors?▼

Yes, you can create API references by submitting your code to generate reader-friendly documentation that accurately details functions, classes, parameters, returns, errors, and runnable examples.

What is the best way to write JSDoc or inline docstrings that explain side effects?▼

Writing inline docstrings or JSDoc is best handled by analyzing module behavior to produce accurate documentation that explains inputs, outputs, side effects, and edge cases for consumers.

Does this documentation approach work for developer onboarding and library maintenance?▼

Yes, this documentation approach works for developer onboarding and library maintenance by explaining module behavior to internal teams and consumers through clear usage guides and API references.

How do I ensure generated documentation includes accurate treatment of limitations and edge cases?▼

Ensure accurate treatment of limitations by requiring the documentation generator to analyze source code inputs, outputs, errors, side effects, and edge cases before drafting the final usage guide.

Why does my generated documentation lack runnable examples for my API?▼

Documentation lacks runnable examples when the source code behavior is not fully analyzed, requiring accurate treatment of inputs, outputs, and errors to generate functional API references.

Related Skills

Explore More Software Engineering Skills→
drgon1drgon1
1

awesome-rules

Standardize code style, comments, and clean-code decisions for source code generation and review.

Community
Intermediate
georgekhananaevgeorgekhananaev
27

md

Enforce consistent Markdown syntax across documentation and README files.

Community
Basic
keshavraj936keshavraj936

lint-and-validate

Lint and statically analyze Node.js and Python code modifications.

Community
Intermediate
criccominicriccomini
42

write-like-paul-graham

Draft and revise essays with thesis-first structure and plain diction.

Community
Intermediate