documentation-structure

Validate documentation heading hierarchy, metadata, file naming, navigation, and cross-references.

29|22|Updated Nov 25, 2025
One-click install
npx skills add https://github.com/canonical/copilot-collections --skill documentation-structure-canonical
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-structure
Source: https://github.com/canonical/copilot-collections/tree/main/assets/skills/documentation-structure
Command: npx skills add https://github.com/canonical/copilot-collections --skill documentation-structure-canonical

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures that documentation adheres to established structural integrity standards, preventing common organizational issues.

Core Features & Use Cases

  • Structural Validation: Checks heading hierarchy, metadata presence, file naming conventions, and navigation links.
  • Cross-Reference Integrity: Verifies that internal links are correctly formatted and resolvable.
  • Use Case: Before merging a new set of documentation pages, use this Skill to automatically flag any structural inconsistencies or broken links, ensuring a professional and navigable final product.

Quick Start

Run the documentation structure audit on the files in the current directory.

Frequently Asked Questions about documentation-structure

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

FAQPage Schema
How do I check documentation structure for heading hierarchy and broken cross-references before merging?▼

Run an automated documentation audit to validate heading hierarchy, metadata presence, file naming conventions, and internal cross-references, ensuring technical writing consistency and navigability before merging content.

What is documentation validation and when do I need it for content management workflows?▼

Documentation validation verifies structural integrity by checking heading hierarchy, metadata, and cross-references. It is needed in content management workflows to ensure consistency and discoverability across technical writing repositories.

Does the documentation structure audit work with Diataxis principles and repository-specific conventions?▼

Yes, the documentation structure audit requires adherence to Diataxis principles and repository-specific documentation conventions to accurately validate structural integrity and navigation links within technical writing workflows.

Can I automatically flag broken internal links and metadata inconsistencies in my documentation files?▼

Yes, you can automatically flag broken internal links and metadata inconsistencies by running a documentation structure audit that verifies cross-reference integrity and checks for required metadata presence.

What's the best way to audit file naming conventions and navigation links in technical documentation?▼

The best way to audit file naming conventions and navigation links is to run a documentation structure audit that validates these elements against repository-specific conventions to ensure professional and navigable final products.