documentation

Create and manage technical documentation with templates for READMEs, ADRs, and runbooks.

Updated Mar 16, 2026

Search Tags:#ADR #technical documentation #README #runbook #docs-as-code

Ready to run

npx skills add https://github.com/ivegamsft/work-tracker --skill documentation-ivegamsft

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/ivegamsft/work-tracker/tree/main/.agents/skills/documentation
Command: npx skills add https://github.com/ivegamsft/work-tracker --skill documentation-ivegamsft

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This skill solves the problem of creating and managing technical documentation, including READMEs, ADRs, runbooks, and implementing docs-as-code practices.

Core Features & Use Cases

Templates for Documentation Types: Provides templates for various documentation types like READMEs, ADRs, and runbooks.
Documentation Standards: Assists in establishing documentation standards for a project.
Agent Pairing: Can be used alongside agents like tech-writer, solution-architect, devops-engineer, and product-manager for comprehensive documentation creation.

Quick Start

Use the documentation skill to create a new README using the README template.

Frequently Asked Questions about documentation

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

FAQPage Schema

How do I create technical documentation like READMEs and runbooks?▼

To create technical documentation like READMEs and runbooks, you can use provided templates and guidelines that establish project documentation standards. This skill supports Markdown formatting and YAML parsing to structure content.

What is the docs-as-code approach for managing technical documentation?▼

The docs-as-code approach manages technical documentation alongside source code using tools that support Markdown formatting and YAML parsing. This practice integrates documentation creation directly into software engineering workflows.

Does this technical documentation skill work with VS Code and Cursor?▼

Yes, this technical documentation skill works with VS Code, Cursor, Windsurf, and Claude Code. It requires YAML parsing and Markdown formatting capabilities to generate documents from templates.

How do I write an Architecture Decision Record for my project?▼

To write an Architecture Decision Record (ADR), use the provided ADR templates to standardize your architectural decisions. The skill offers specific documentation templates to capture technical context and reasoning.

Can I use this skill alongside a tech-writer or devops-engineer agent?▼

Yes, you can use this skill alongside tech-writer, solution-architect, devops-engineer, and product-manager agents. This pairing enables comprehensive documentation creation and standardized runbooks.