documentation-writer

Generate READMEs, API references, and architecture guides from code.

1|Updated Apr 22, 2026
One-click install
npx skills add https://github.com/unrealandychan/AgentFoundry --skill documentation-writer-unrealandychan
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-writer
Source: https://github.com/unrealandychan/AgentFoundry/tree/main/skills/documentation-writer
Command: npx skills add https://github.com/unrealandychan/AgentFoundry --skill documentation-writer-unrealandychan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation is often manual and error-prone. This Skill converts code and repository structures into organized, publish-ready documentation including setup guides, architecture overviews, API references, and onboarding notes.

Core Features & Use Cases

  • Generate READMEs, API references, and architecture guides directly from code and repo structure.
  • Maintain consistency across documentation by deriving sections from code comments and project structure.
  • Use Case: Onboard new developers by auto-generating a complete docs package from an existing codebase.

Quick Start

Ask the agent to generate documentation for a given codebase focusing on API references and architecture overview.

Frequently Asked Questions about documentation-writer

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

FAQPage Schema
How do I generate a README from code comments and docstrings?

You can generate a README by using an agent to analyze your codebase, automatically extracting details from code comments and docstrings to produce structured, publish-ready documentation. It derives consistent sections directly from your repository layout and code.

Can I automatically create API references from my repository structure?

Yes, you can automatically create API references by pointing the agent at your repository structure. It infers and extracts details from code comments and docstrings to generate organized API documentation without manual formatting.

What is the best way to write architecture guides for onboarding new developers?

The best way to write architecture guides for onboarding is to auto-generate a complete docs package from your existing codebase. This approach derives setup guides and architecture overviews directly from the repository layout and code structure.

Does this documentation generation approach support multiple output formats?

Yes, this approach supports multiple output formats for your generated documentation. It converts code and repository structures into organized, publish-ready docs while preserving a consistent structure across all outputs.

How do I maintain consistency across software documentation without manual effort?

You maintain consistency across software documentation by deriving sections automatically from code comments and project structure. This ensures every generated document follows the same structure without manual formatting or error-prone updates.