documentation-and-adrs

Name: documentation-and-adrs
Availability: InStock
Author: zxyycom

Draft ADRs and synchronize documentation across OpenSpec and related docs.

Updated Jun 4, 2026

Search Tags:#architecture #documentation #adr #governance #change-management #docnav

Ready to run

npx skills add https://github.com/zxyycom/docnav --skill documentation-and-adrs-zxyycom

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/zxyycom/docnav/tree/main/.codex/skills/documentation-and-adrs
Command: npx skills add https://github.com/zxyycom/docnav --skill documentation-and-adrs-zxyycom

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Records and organizes durable decisions and contextual documentation to guide future engineers and AI agents through architectural changes and governance.

Core Features & Use Cases

ADR governance: capture rationale, constraints, and trade-offs for long-term decisions.
Inline documentation patterns: provide guidance on when to add inline notes, reference ADRs, and link related docs.
Docnav synchronization guidance: outline how to keep doc navigation, OpenSpec changes, and contract surfaces aligned.

Quick Start

Write an ADR in docs/decisions/ADR-XXX-Title.md and reference it from the relevant OpenSpec or main contract documentation to ensure traceability.

Frequently Asked Questions about documentation-and-adrs

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

FAQPage Schema

How do I write an architecture decision record to capture project rationale?▼

To write an architecture decision record, draft your file in docs/decisions/ADR-XXX-Title.md conforming to ADR templates, then reference it from relevant OpenSpec or main contract documentation to ensure traceable governance and preserve durable decisions.

What is the best way to keep documentation navigation aligned with OpenSpec changes?▼

Keeping documentation navigation aligned with OpenSpec changes requires docnav synchronization guidance, outlining how to keep doc navigation, OpenSpec changes, and contract surfaces aligned to maintain durable architectural decisions and contextual documentation.

When do I need to add inline documentation versus a full ADR?▼

You need inline documentation when providing guidance on when to add inline notes, reference ADRs, and link related docs. A full ADR is needed to capture rationale, constraints, and trade-offs for long-term durable architectural decisions and governance.

How do I link OpenSpec changes to architectural decisions for traceable governance?▼

Link OpenSpec changes to architectural decisions by conforming to ADR templates, linking OpenSpec changes, and referencing schemas, examples, and tests within your documentation to ensure traceable governance across the project context.

Can I use ADR templates to guide future engineers and AI agents through architectural changes?▼

Yes, you can use ADR templates to capture durable architectural decisions and essential project context, applying ADR drafting and inline documentation guidance to guide future engineers and AI agents through architectural changes and governance.

Why does docnav synchronization matter for maintaining durable project context?▼

Docnav synchronization matters because it outlines how to keep doc navigation, OpenSpec changes, and contract surfaces aligned, ensuring that durable architectural decisions and contextual documentation remain traceable and accessible for future engineers and agents.