skills.rest
jamieadams-nerd
jamieadams-nerdCOMMUNITY
Explore all skills by this author →
GitHub

doc-workflow-rules

Enforce UMRS documentation workflow rules for Antora modules and AsciiDoc content.

Updated Dec 4, 2025
Search Tags:#workflow#documentation#archive#docs#asciidoc#antora
One-click install
npx skills add https://github.com/jamieadams-nerd/umrs-project --skill doc-workflow-rules
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-workflow-rules
Source: https://github.com/jamieadams-nerd/umrs-project/tree/main/.claude/skills/doc-workflow-rules
Command: npx skills add https://github.com/jamieadams-nerd/umrs-project --skill doc-workflow-rules

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation workflow rules for UMRS ensure consistent processes for editing, Antora module structure, and publishing to prevent drift and unsafe updates.

Core Features & Use Cases

  • Build Verification Rule: ensure docs build cleanly with Antora after edits.
  • Archive-First Rule: never delete documentation; archive to docs/_scratch/ instead.
  • Inbox Routing Rule: route doc content to agent inbox under .claude for processing and eventual archiving.
  • Antora Structure Rule: enforce docs/modules/nav.adoc structure and module layout for publishable pages.
  • Scratch Directory Rule: use docs/_scratch/ for content that needs staging or retirement from build.
  • Xref Safety Rule: verify cross-references across all AsciiDoc pages to prevent broken links.
  • AsciiDoc Conversion Rule: apply conversion and formatting standards during content processing.
  • File Format Rule: ensure publishable content is .adoc or compatible.

Quick Start

Follow these rules whenever you edit docs/, write .adoc content, or manage Antora modules to maintain a compliant, archive-safe documentation workflow.

Frequently Asked Questions about doc-workflow-rules

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

FAQPage Schema
How do I enforce Antora documentation workflow rules for safe publishing?▼

To enforce Antora workflow rules, apply build verification, archive-first deletion policies, and xref safety checks across .adoc content. This standardizes module structure in docs/modules/nav.adoc and routes content through an inbox for safe processing.

What is the best way to manage broken cross-references in AsciiDoc pages?▼

The best way to manage broken cross-references in AsciiDoc is to apply an xref safety check across all pages. This verifies link integrity within Antora modules and prevents broken navigation in the published build.

How do I archive documentation without deleting files in Antora?▼

You archive documentation without deleting files by moving content to docs/_scratch/ for staging or retirement. This archive-first rule ensures no documentation is permanently deleted, maintaining a safe historical record.

Does Antora require a specific file format and module structure for publishing?▼

Antora requires .adoc file formats and a strict module structure for publishing. Enforcing the docs/modules/nav.adoc layout ensures publishable pages are correctly organized, routed, and verified for clean builds.

Why do I need to route doc content to an agent inbox under .claude?▼

Routing doc content to an agent inbox under .claude centralizes files for processing and eventual archiving. This inbox routing step ensures all updates pass through workflow verification before final publication or retirement.

Related Skills

Explore More Content & Communication Skills→
stephendolanstephendolan
2

documentation-standards

Review README.md files for compliance with documentation standards.

Community
Basic
zerobias-orgzerobias-org

regenerate-types

Regenerate TypeScript interfaces from api.yml after API changes.

Official
Intermediate
albertoiruruetaalbertoirurueta

antora-setup

Set up Antora documentation with Node.js, configuration files, and a ROOT module.

Community
Intermediate
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate