documentation

Write and maintain ADRs, READMEs, and technical documentation with maintenance matrices.

3|Updated Apr 2, 2026
One-click install
npx skills add https://github.com/OktayCopurlu/ai-shared --skill documentation-oktaycopurlu
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/OktayCopurlu/ai-shared/tree/main/.github/workflows/skills/documentation
Command: npx skills add https://github.com/OktayCopurlu/ai-shared --skill documentation-oktaycopurlu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Technical documentation drifts out of sync with code: ADRs get deleted instead of superseded, READMEs contain stale commands, and cross-file changes leave docs, configs, and registrations inconsistent. This Skill provides standards for writing and maintaining documentation that stays accurate. ## Core Features & Use Cases - ADR Standards: Rules for recording architecture decisions, including never deleting ADRs and marking them Deprecated or Superseded with links to replacements. - README Structure: A standard section order (What is this, Quick start, Architecture, Development, Environment, Troubleshooting) for module and service READMEs. - Maintenance Matrix: A table mapping changes to co-dependent files (routes, barrel exports, env vars, schemas) so contributors and agents update everything that a change touches. - Use Case: When adding a new API route, consult the maintenance matrix to also update the route index, tests, OpenAPI spec, and README API section in the same PR. ## Quick Start Ask the AI to write an ADR for a recent architecture decision or to audit a module README against the documentation standards.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I write an architecture decision record (ADR)?▼

An ADR records a decision, its context, and its consequences honestly, including downsides. Never delete an ADR; mark it Deprecated or Superseded and link the replacement. Any decision debated for more than 10 minutes deserves one.

What sections should a module README include?▼

A module or service README should answer: What is this, Quick start, Architecture, Development, Environment, and Troubleshooting. Lead with the most useful information, use code blocks for commands, and link instead of duplicating content.

What is a maintenance matrix in documentation?▼

A maintenance matrix maps change dependencies, such as which files to update when a route, component, environment variable, or schema changes. It lists real file paths including tests and docs, and lives in AGENTS.md or CONTRIBUTING.md near build instructions.

When should documentation be updated relative to code changes?▼

Update docs in the same pull request as the behavior change, not afterward. Add a Last updated date to guides that drift, and update the maintenance matrix itself whenever the project structure changes.

When is this documentation skill not the right tool?▼

It does not cover Jira ticket writing, which belongs to the jira-ticket skill, or inline code comments and naming conventions, which belong to applying-coding-style. Use it for ADRs, READMEs, wikis, and onboarding docs.