documentation

Produce audience-focused technical documentation for software systems and operational procedures.

Updated Aug 23, 2026

Search Tags:#architecture #documentation #onboarding #readme #runbook #technical-writing #api-docs

Ready to run

npx skills add https://github.com/SMOrchestra-ai/smorch-brain --skill documentation-smorchestra-ai

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/SMOrchestra-ai/smorch-brain/tree/main/plugins/engineering/skills/documentation
Command: npx skills add https://github.com/SMOrchestra-ai/smorch-brain --skill documentation-smorchestra-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Technical knowledge is often scattered, outdated, or written for the wrong audience, causing onboarding delays, operational errors, and slow developer productivity. This Skill provides structured guidance to create and maintain readable, actionable documentation that reduces context switching and support load.

Core Features & Use Cases

README authoring: Explain purpose, quick-start steps, configuration, and contribution workflow so new users reach value quickly.
API documentation: Produce endpoint references with examples, authentication details, and error codes for SDK and integration teams.
Runbooks & operational guides: Provide step-by-step procedures, rollback steps, and escalation paths for incident response and maintenance.
Architecture and onboarding: Capture high-level designs, key decisions, diagrams, and developer environment setup for faster team ramp-up.

Quick Start

Write a README that explains the project purpose, provides a five-minute quick start, and lists configuration and contributing steps.

Frequently Asked Questions about documentation

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

FAQPage Schema

How do I write a README with a quick start guide and configuration steps?▼

To write a README, structure the content to explain the project purpose, provide a five-minute quick start, and list configuration and contributing steps so new users reach value quickly.

What is the best way to create API documentation with endpoint examples and error codes?▼

The best way to create API documentation is to produce endpoint references complete with examples, authentication details, and error codes tailored for SDK and integration teams.

How do I write a runbook for incident response and maintenance procedures?▼

To write a runbook, provide step-by-step operational procedures, rollback steps, and escalation paths specifically designed for incident response and routine maintenance workflows.

How to document software architecture and developer environment setup for onboarding?▼

Document software architecture by capturing high-level designs, key decisions, diagrams, and developer environment setup instructions to enable faster team ramp-up and onboarding.

What should technical documentation include to ensure clarity and maintainability?▼

Technical documentation should include structured context, examples, step-by-step instructions, decision rationale, and adhere to principles like linking instead of duplication for maintainability.

When do I need a dedicated runbook versus standard API docs for my software system?▼

You need a dedicated runbook for operational procedures like incident response and maintenance, whereas API docs are needed for endpoint references targeting SDK and integration teams.