doc-agent

Generate README files, API references, and docstrings from source code.

Updated Dec 3, 2025
One-click install
npx skills add https://github.com/Unicorn/Radium --skill doc-agent-unicorn
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-agent
Source: https://github.com/Unicorn/Radium/tree/main/skills/core/doc-agent
Command: npx skills add https://github.com/Unicorn/Radium --skill doc-agent-unicorn

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates clear, consistent, and up-to-date documentation to reduce onboarding friction, prevent knowledge loss, and save engineering time spent writing READMEs, API references, and code comments.

Core Features & Use Cases

  • README and Guides: Produce project overviews, installation steps, quick starts, and contributing guidelines.
  • API Documentation: Extract endpoints, request/response formats, authentication details, and provide code examples across languages.
  • Code Documentation & Tutorials: Write docstrings, explain architecture decisions, create troubleshooting guides, and maintain changelogs.
  • Use Case: Convert a backend repository into a developer handbook and API reference for internal and external developers.

Quick Start

Create a README and API reference for the repository, including setup instructions, usage examples, and endpoint request/response details.

Frequently Asked Questions about doc-agent

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

FAQPage Schema
How do I generate API documentation and README files from source code?

Generate API documentation and README files by providing repository source code, function signatures, and endpoint definitions to produce installation steps, usage examples, and request response details automatically.

What is the best way to write docstrings and architecture overviews for a backend repository?

Writing docstrings and architecture overviews for a backend repository involves processing source code and example inputs to extract endpoint formats, explain architecture decisions, and create a developer handbook automatically.

Can I create troubleshooting guides and changelogs from existing function signatures?

Creating troubleshooting guides and changelogs from existing function signatures requires access to source code and example inputs to accurately explain architecture decisions and maintain historical project changes.

What source code inputs do I need to produce accurate endpoint docs and parameter descriptions?

Producing accurate endpoint docs and parameter descriptions requires source code, function and endpoint signatures, and example inputs to ensure generated API references contain correct usage examples.

Does generating API references work for both internal and external developer onboarding?

Generating API references works for internal and external developer onboarding by converting backend repositories into developer handbooks with clear setup instructions, endpoint details, and contributing guidelines.