skills.rest
s977043
s977043COMMUNITY
Explore all skills by this author →
𝕏@mine_takeGitHub

code-documentation

Generate documentation for code and APIs with usage examples and verification checks.

2|Updated Sep 13, 2025
Search Tags:#documentation#api#guidance#readme#docs
One-click install
npx skills add https://github.com/s977043/river-reviewer --skill code-documentation-s977043
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-documentation
Source: https://github.com/s977043/river-reviewer/tree/main/skills/agent-skills/code-documentation
Command: npx skills add https://github.com/s977043/river-reviewer --skill code-documentation-s977043

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you produce concise, accurate documentation for code and APIs, speeding up onboarding and reducing support queries.

Core Features & Use Cases

  • Documentation blueprint: outlines README structure, API signatures, and usage examples.
  • Inline guidance: explains reasoning behind design choices to aid future readers.
  • Quick Start: create a sample README for a new feature with one example API call.

Quick Start

Provide a minimal sample README for a new API endpoint, including a quick example and setup notes.

Frequently Asked Questions about code-documentation

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

FAQPage Schema
How do I write clear API documentation with usage examples?▼

API documentation should include purpose, prerequisites, signatures, return values, error handling, and runnable examples. This Skill generates concise API docs covering all these elements to speed onboarding and reduce support overhead.

What should a README include for a new feature or API endpoint?▼

A README should outline setup notes, quick-start examples, API calls, and inline rationale for design choices. This Skill provides a documentation blueprint to structure these sections and ensure complete coverage for new features.

How do I document code to make it easier for other developers to understand?▼

Inline guidance explaining reasoning behind design choices helps future readers understand intent and trade-offs. This Skill generates inline documentation and rationale to clarify unclear areas and reduce onboarding friction.

Can I use this to document both public APIs and internal code?▼

Yes. This Skill applies to READMEs, API documentation, and inline guidance for both external APIs and internal code. It ensures consistent coverage of purpose, prerequisites, usage steps, signatures, and examples across your codebase.

How do I verify my documentation is complete and accurate?▼

This Skill includes verification via lint and build checks to confirm documentation covers all required elements—signatures, return values, errors, examples, and dummy secrets—before deployment.

What's the fastest way to create documentation for a new API endpoint?▼

Use the quick-start feature: provide your API endpoint and one example call, and this Skill generates a sample README with setup notes and usage guidance in minutes rather than hours.

Related Skills

Explore More Software Engineering Skills→
nashgaonashgao
3

doc-functions-explain

Generate documentation for functions, methods, and classes across multiple programming languages.

Community
Advanced
SSiertsemaSSiertsema

documentation-tooling-selection

Evaluate documentation tooling against audience, content, and technical criteria.

Community
Advanced
ArcadeAIArcadeAI
8

verify

Run tests, linting, dependency audits, and documentation checks for ticket verification.

Official
Intermediate
jikimejikime
5

jikime-workflow-docs

Generate API documentation and static doc sites from code using Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Intermediate