documentation-templates

Generates README, API docs, runbooks, and code comments using structured documentation templates.

Updated Apr 13, 2026

Search Tags:#templates #documentation #markdown #readme #code comments #api docs #runbook

Ready to run

npx skills add https://github.com/JenilRevaliya/ARGUS --skill documentation-templates-jenilrevaliya

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/JenilRevaliya/ARGUS/tree/main/.agent/skills/documentation-templates
Command: npx skills add https://github.com/JenilRevaliya/ARGUS --skill documentation-templates-jenilrevaliya

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing consistent, human-readable project documentation is time-consuming and often skipped, leaving codebases without READMEs, API references, or incident runbooks that new developers and on-call engineers depend on. ## Core Features & Use Cases - README Template: Provides a complete README structure with Quick Start, requirements, environment variables, and testing sections. - API Documentation Standards: Defines a per-endpoint format covering request bodies, response codes, and curl examples. - Runbook & Comment Rules: Supplies an incident runbook template and guidelines for writing why-focused code comments and AI-friendly docs like CODEBASE.md. - Use Case: A developer finishing a new service asks the AI to generate a README and API docs; the skill produces both following the standard templates, including environment variable tables and endpoint examples. ## Quick Start Ask the AI to write a README for your project using the documentation templates skill.

Frequently Asked Questions about documentation-templates

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

FAQPage Schema

How do I write a good README for my project?▼

A good README starts with a one-sentence description, then a Quick Start section with copy-paste commands, followed by requirements, project structure, environment variables, and test instructions. The first 30 seconds of reading determine whether someone adopts your project.

How to document a REST API endpoint?▼

Document each endpoint with its purpose, a request body schema showing types and constraints, a response table mapping status codes to meanings and bodies, and a working curl example. Cover success, validation failure, and conflict cases.

What should code comments explain?▼

Comments should explain why code exists, not what it does. Always comment non-obvious business rules, workarounds for library bugs, performance decisions that look premature, and magic numbers with their justification.

What is a runbook and when do I need one?▼

A runbook is an operational document for on-call engineers listing symptoms, likely causes, investigation commands, resolution steps, and escalation paths. You need one for any production service that may fail outside business hours.

How do I make documentation AI-friendly?▼

Keep a CODEBASE.md with tech stack and conventions, an ARCHITECTURE.md with system boundaries and data flow, and @purpose comments on complex functions. Also mark auto-generated files that should not be edited directly.