documentation

Generate reader-focused documentation and runbooks from live system behavior.

108|27|Updated Mar 26, 2026
One-click install
npx skills add https://github.com/diegosouzapw/omni-skills --skill documentation-diegosouzapw
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/diegosouzapw/omni-skills/tree/main/skills/documentation
Command: npx skills add https://github.com/diegosouzapw/omni-skills --skill documentation-diegosouzapw

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Documentation is often misaligned with live system behavior, leading to onboarding confusion, outdated guides, and inconsistent runbooks. This Skill helps turn actual implementation into accurate, reader-focused documentation, runbooks, and contributor guidance.

Core Features & Use Cases

  • Generates up-to-date onboarding materials, guides, and SOPs that reflect current behavior.
  • Aligns docs with changes in code, releases, and workflows to reduce drift.
  • Produces structured packets including quick starts, verification steps, and troubleshooting guidance for contributors and operators.

Quick Start

Ask it for a complete reader-ready documentation packet for a feature or change you are documenting.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I create onboarding documentation from live system behavior?

Create onboarding documentation from live system behavior by generating reader-focused packets with verifiable steps, frontmatter metadata, and troubleshooting checklists. This ensures guides accurately reflect current implementation rather than relying on outdated specs.

What is the best way to keep runbooks aligned with current code changes?

Keep runbooks aligned with current code changes by enforcing structure and frontmatter metadata that map directly to live workflows. This reduces drift between operational documentation and actual system implementation across releases.

How do I generate a complete documentation packet for a new feature release?

Generate a complete documentation packet for a new feature release by requesting reader-ready quick starts, verification steps, and troubleshooting guidance. The output includes structured artifacts tailored for both contributors and operators.

Can I use this to write contributor guidance and SOPs for my team?

Yes, you can write contributor guidance and SOPs for your team. The skill produces structured packets including quick starts, verification steps, and troubleshooting guidance tailored for contributors and operators reflecting current behavior.

Why does my existing documentation keep drifting from actual implementation?

Documentation drifts from actual implementation when guides are not mapped to live system behavior. Enforcing structure with frontmatter metadata and verifiable checklists ensures documentation stays aligned with current code and workflows.