documentation

Automate creation and maintenance of technical documentation tied to code changes.

1|Updated Mar 17, 2026

Search Tags:#documentation #adr #maintainability #reference #tutorial #runbook #docs-as-code

Ready to run

npx skills add https://github.com/yknothing/prodcraft --skill documentation-yknothing

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/yknothing/prodcraft/tree/main/skills/cross-cutting/documentation
Command: npx skills add https://github.com/yknothing/prodcraft --skill documentation-yknothing

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation needs arise from features, architecture decisions, incidents, or workflow changes, and durable documentation reduces onboarding time, preserves context, and enables async collaboration.

Core Features & Use Cases

Tutorials for onboarding and getting started
How-to guides for common tasks and workflows
Reference docs and architecture decision records (ADRs)
Runbooks and maintenance guides for operations and incident response
Documentation as code with versioning, review, and discoverability

Quick Start

Create and publish a new ADR in docs/adr/ detailing the latest architecture decision.

Frequently Asked Questions about documentation

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

FAQPage Schema

How do I automate technical documentation creation tied to code changes?▼

Automating technical documentation tied to code changes requires applying docs-as-code practices, using an authoring and review workflow to generate durable artifacts like tutorials and runbooks for new features. This ensures consistent, discoverable documentation.

What is the best way to maintain architecture decision records alongside feature development?▼

Maintaining architecture decision records (ADRs) alongside development uses a docs-as-code workflow to publish decisions to designated locations like docs/adr. This preserves context and ensures architecture choices remain discoverable during onboarding.

How do I create a runbook for incident response and operations?▼

Creating a runbook for incident response involves documenting maintenance guides and operational workflows triggered by incidents. This captures necessary context and procedures, enabling async collaboration and consistent operations during future disruptions.

Can I use docs-as-code practices for onboarding tutorials and reference materials?▼

Docs-as-code practices support onboarding tutorials and reference materials by applying versioning and review workflows. This ensures documentation artifacts remain durable, discoverable, and synchronized with codebase changes for new team members.

When do I need to update technical documentation for workflow changes?▼

You need to update technical documentation for workflow changes when new features, architecture decisions, or incidents occur. Tying updates to these events maintains durable reference materials and reduces onboarding time for async teams.