documentation

Write and maintain technical documentation for software products and workflows.

2|1|Updated May 17, 2026

Search Tags:#documentation #onboarding #readme #api docs #runbook

Ready to run

npx skills add https://github.com/rakibulism/agent-skills-os --skill documentation-rakibulism

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/rakibulism/agent-skills-os/tree/main/skills/engineering-documentation
Command: npx skills add https://github.com/rakibulism/agent-skills-os --skill documentation-rakibulism

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you create, improve, and maintain technical documentation so teams can understand systems, use products correctly, and follow operational procedures without confusion.

Core Features & Use Cases

README Writing: Draft clear project overviews, setup steps, usage guidance, and contribution notes.
API and Architecture Docs: Produce endpoint references, integration guidance, design rationales, and trade-off summaries.
Runbooks and Onboarding Guides: Create step-by-step operational procedures, rollback instructions, and practical onboarding materials.
Use Case: A team launching a new service can use this Skill to generate the README, API reference, and incident runbook needed for users and operators.

Quick Start

Ask the assistant to write or improve the documentation for your project, audience, and document type using the information you provide.

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 file that clearly explains project setup and usage?▼

To write a clear README, provide the assistant with your project details and audience. It generates a structured README containing the project overview, setup steps, usage guidance, and contribution notes.

What is the best way to generate API reference documentation for software integrations?▼

The best way to generate API documentation is to provide your endpoint details to this assistant. It produces endpoint references, integration guidance, design rationales, and trade-off summaries for your software products.

How do I create an operational runbook with step-by-step rollback instructions?▼

You create an operational runbook by asking the assistant to draft procedures for your specific systems. It structures the document with step-by-step operational procedures and rollback instructions for operators.

Can I use this to write onboarding guides for new team members joining a software project?▼

Yes, you can use this to write onboarding guides. Provide the system context and audience level, and it generates practical onboarding materials to help new team members understand operational workflows correctly.

Does this documentation tool work for maintaining architecture docs and design rationales?▼

Yes, this tool maintains architecture docs by organizing system designs and trade-off summaries. It structures complex knowledge into clear, audience-aware documents that remain maintainable for readers.

What do I need to provide to generate technical documentation for a new service launch?▼

You need to provide the project information, target audience, and document type. The assistant uses these inputs to apply clear structure, examples, and audience-aware organization to your technical documentation.