documentation

Generate Markdown technical documentation with frontmatter metadata and structured outlines.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/PoyoPoak/FastAPI-App-Template --skill documentation-poyopoak
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/PoyoPoak/FastAPI-App-Template/tree/main/.agents/skills/documentation
Command: npx skills add https://github.com/PoyoPoak/FastAPI-App-Template --skill documentation-poyopoak

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Organizations often struggle to create and maintain clear, up-to-date technical documentation across READMEs, API references, runbooks, architecture notes, and onboarding guides.

Core Features & Use Cases

  • README: Provides quick start, configuration guidance, usage instructions, and contribution guidelines.
  • API Documentation: Detailed endpoint references with examples, authentication notes, error codes, rate limits, pagination, and SDK samples.
  • Runbook: Standard procedures for common operational tasks, prerequisites and access details, step-by-step instructions, rollback steps, and escalation paths.
  • Architecture Doc: Context, high-level design, key decisions and trade-offs, data flow, and integration points.
  • Onboarding Guide: Environment setup, key systems and how they connect, common tasks with walkthroughs, and who to contact.

Quick Start

Produce an initial, publish-ready documentation package covering README, API docs, runbooks, and onboarding guides for your project.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I generate a runbook for standard operational procedures?

To generate a runbook for standard operational procedures, this Skill automates creating Markdown documents detailing prerequisites, step-by-step instructions, rollback steps, and escalation paths for common operational tasks.

What is the best way to write API documentation with endpoint references?

The best way to write API documentation with endpoint references is using this Skill to generate detailed Markdown references covering examples, authentication notes, error codes, rate limits, pagination, and SDK samples.

How do I create an onboarding guide for a new software project?

To create an onboarding guide for a new software project, this Skill automates generating Markdown guides detailing environment setup, key system connections, common task walkthroughs, and contact information for new team members.

Can I include architecture notes and design trade-offs in technical documentation?

Yes, you can include architecture notes and design trade-offs in technical documentation. This Skill generates architecture documents capturing context, high-level design, key decisions, data flow, and integration points.

Does the generated technical documentation support frontmatter-driven metadata?

Yes, the generated technical documentation supports frontmatter-driven metadata. The Skill produces Markdown files with structured document outlines and frontmatter metadata, supporting optional scripts, references, and assets.

What should a README include for quick start and configuration guidance?

A README for quick start and configuration guidance should include usage instructions and contribution guidelines. This Skill automates generating these README sections alongside API references, runbooks, and onboarding guides.