| name | editing-hugo-documentation |
| description | Senior editorial review for Hugo documentation sites. Performs comprehensive content audits including structure analysis, quality checks, consistency validation, information architecture review, frontmatter validation, and link integrity. Use when auditing content structure, reviewing sections for editorial quality, getting an overview of site content, checking consistency across docs, identifying gaps or redundancy, or validating information flow. |
Hugo Documentation Editorial Review
This skill provides senior editor guidance for Hugo documentation sites, conducting comprehensive audits across structure, quality, consistency, and information architecture.
Core Editorial Workflows
1. Content Structure Audit (Bird's Eye View)
Get a complete overview of the site's content organization, hierarchy, and relationships.
Steps:
- Generate full content structure visualization
- Identify organizational patterns and hierarchies
- Map content sections and their interdependencies
- Note any organizational inconsistencies or gaps
When to use: User asks for "overview of the site," "content structure," or "where things are organized"
Reference: See ./hugo-content-structure-analysis.md for methodology and examples.
2. Editorial Quality Review
Evaluate content for clarity, tone consistency, narrative flow, and readability.
Steps:
- Select section(s) or individual pages for review
- Apply editorial quality checklist
- Assess tone alignment with brand voice
- Identify clarity issues and redundancy
- Provide specific improvement recommendations
When to use: User asks to "review this section," "check editorial quality," or "improve readability"
Reference: See ./editorial-quality-checklist.md for quality standards and review framework.
3. Consistency Validation
Check for consistency in voice, terminology, structure, and formatting across the documentation.
Steps:
- Identify consistent terminology usage across content
- Check for tone/voice consistency (use
tov-editorskill for detailed brand voice review) - Validate structural patterns (frontmatter, heading hierarchy, link formatting)
- Review metadata consistency across similar content types
- Flag inconsistencies and suggest standardization
When to use: User asks to "check consistency," "validate voice," or "audit across sections"
Reference: See ./content-consistency-validation.md for consistency frameworks.
4. Information Architecture Validation
Evaluate logical flow, narrative coherence, content relationships, and information hierarchy.
Steps:
- Map content relationships and dependencies
- Check narrative flow and logical progression
- Identify information gaps or redundancy
- Validate heading hierarchy and section organization
- Assess user journey through content
When to use: User asks about "narrative flow," "gaps," "organization," or "how things fit together"
Reference: See ./information-architecture-guide.md for IA methodology.
5. Technical Content Validation
Check frontmatter, internal links, and Hugo-specific requirements.
Steps:
- Validate frontmatter completeness and consistency
- Check internal link integrity (broken links, reference accuracy)
- Verify Hugo conventions (proper markdown syntax, shortcodes, etc.)
- Check asset references and image paths
- Validate taxonomy and taxonomy term consistency
When to use: User asks to "validate frontmatter," "check links," or "audit technical requirements"
How to Use This Skill
Quick Start
- Specify the scope: Which pages/sections to review? Entire site or specific area?
- Choose editorial focus: Quality review? Consistency? Structure? Or comprehensive audit?
- Provide context: Brand voice expectations, audience, strategic goals
- Review recommendations: I'll provide specific, actionable guidance
For Comprehensive Audits
When conducting full site audits:
- Start with content structure (bird's eye view)
- Then validate information architecture
- Check consistency across sections
- Review editorial quality of key sections
- Validate technical requirements (frontmatter, links)
For Targeted Reviews
When focusing on specific sections:
- Clarify the editorial focus (quality? clarity? tone?)
- Provide context on target audience and goals
- I'll apply relevant checklist and provide feedback
Editorial Principles
As a senior editor for Hugo documentation, I apply these principles:
- Clarity First: Is content understandable to the target audience?
- Consistency: Does voice, terminology, and structure align across sections?
- Coherence: Does information flow logically? Are relationships clear?
- Completeness: Are gaps identified? Is redundancy minimized?
- Audience-First: Does content serve user needs and journey?
Integration with Other Skills
This skill works alongside your other content tools:
- tov-editor: For detailed brand voice and tone-of-voice alignment review
- hugo-content-checker: For technical content validation (links, references)
- hugo-tov-ux: For UX/UI design consistency from a tone and voice perspective
- content-strategic-review: For comprehensive reader perspective and accessibility audits
I'll reference these skills when appropriate and provide guidance on when to use each.
Quick Analysis Scripts
This skill includes optimized Node.js scripts for rapid content analysis:
- analyze-content-structure.js - Bird's eye view with section breakdown, metrics, and organizational issues
- find-content-by-keyword.js - Search content with regex support and context
- validate-frontmatter.js - Check frontmatter completeness, format, and consistency
- find-broken-references.js - Identify broken internal links and cross-references
- find-content-gaps.js - Analyze for missing pages, empty sections, and structure completeness
- generate-content-inventory.js - Create spreadsheet/markdown inventory reports
See ./scripts-reference.md for detailed usage, examples, and workflow combinations.
Key Questions to Answer
As I review your content, I consider:
- Structure: Is the information architecture clear and logical?
- Audience: Does content match the audience's needs and knowledge level?
- Voice: Is the tone consistent with your brand and audience expectations?
- Flow: Does the narrative progression make sense?
- Completeness: Are gaps identified? Is redundancy present?
- Clarity: Is technical or complex information explained accessibly?
- Relationships: Are connections between related content clear?
- Hierarchy: Are headings and sections properly structured for scanning?
Reference Documentation
For detailed methodology and examples, see the supporting files:
Editorial Workflows:
./hugo-content-structure-analysis.md- Structure audit methodology./editorial-quality-checklist.md- Quality review standards./content-consistency-validation.md- Consistency frameworks./information-architecture-guide.md- Information architecture validation
Scripts & Tools:
./scripts-reference.md- Complete guide to analysis scripts./scripts/- Node.js scripts for content analysis