ref-documentation

Audit technical documentation tone, structure, and consistency.

4|Updated Jan 11, 2026
One-click install
npx skills add https://github.com/cuioss/plan-marshall --skill ref-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ref-documentation
Source: https://github.com/cuioss/plan-marshall/tree/main/marketplace/bundles/pm-documents/skills/ref-documentation
Command: npx skills add https://github.com/cuioss/plan-marshall --skill ref-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires plan_logging, and includes scripts (resource) and references (resource) components.

What problem does it solve?

Content quality, tone consistency, and organizational standards for technical documentation are guided and enforced through structured reviews, ensuring accuracy and maintainability.

Core Features & Use Cases

  • Tone and style auditing aligned with established standards, with verifiable attributions and cross-references.
  • Organization standards enforcement to maintain consistent structure, naming, and cross-document linking.
  • Review orchestration of multiple workflows (format validation, link verification, content review) to deliver a consolidated quality report.

Quick Start

Invoke the comprehensive-review workflow on a target path to start an end-to-end quality audit.

Frequently Asked Questions about ref-documentation

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

FAQPage Schema
What is the best way to enforce documentation quality standards across design guides?

To audit documentation quality, invoke the comprehensive-review workflow on a target path to start an end-to-end evaluation of tone, structure, and link accuracy.

How do I verify cross-references and links in technical reference materials?

You can verify cross-references by running orchestrated workflows that validate links and check that citations remain accurate and up-to-date across your reference materials.

Does this documentation review process coordinate multiple format validation workflows?

Yes, the review process orchestrates multiple workflows such as format validation, link verification, and content review to deliver a consolidated quality report.

Can I use plan_logging to manage documentation review workflows?

Yes, plan_logging is a required dependency for coordinating the orchestrated workflows that execute format validation, link verification, and content reviews.

What are the limitations of automated documentation tone auditing?

Automated tone auditing enforces neutral tone and consistency but relies on structured inputs and established organization standards to effectively evaluate your reference materials.