What file formats does this skill support?

It primarily focuses on AsciiDoc (.adoc) and README files, providing specific formatting rules for headers, tables of contents, and cross-references.

How does it ensure code examples are accurate?

It requires that code examples are complete, include all necessary imports, follow project standards, and are ideally verified by actual unit tests.

Can it detect broken links in my documentation?

Yes, it utilizes a dedicated Python script to validate cross-reference syntax, check for broken file references, and verify the existence of anchors.

Does it support Table of Contents generation?

Yes, it enforces specific TOC standards, such as using ':toc: macro' for READMEs and ':toc: left' for general documentation files.

How does this skill handle marketing language?

The skill identifies and removes promotional wording, self-praise, and subjective claims, replacing them with objective, factual, and verifiable technical descriptions.

CUI Documentation Standards

Name: CUI Documentation Standards
Author: cuioss

bycuioss

0•

Learning & Documentation

Enforces professional, neutral, and structurally sound technical documentation standards for README and AsciiDoc files.

This skill provides a comprehensive framework for maintaining high-quality technical documentation within CUI OSS projects and beyond. It guides Claude to adhere to specific tone and style requirements—eliminating marketing fluff in favor of objective, verifiable facts—while ensuring consistent AsciiDoc formatting and README structures. With built-in support for automated validation scripts that check link integrity and syntax, this skill helps developers create maintainable, clear, and professional documentation that integrates seamlessly with build processes and project standards.

Key Features

01Enforces a professional, neutral tone by removing marketing and promotional language.

02Ensures code examples are complete, compilable, and derived from actual unit tests.

03Automates documentation quality checks via integrated validation scripts.

04Standardizes README structure including Maven coordinates and core concepts.

05Validates AsciiDoc syntax, headers, and cross-reference (xref) link integrity.

060 GitHub stars

Use Cases

01Performing automated audits of large AsciiDoc documentation suites to find broken links and formatting errors.

02Refactoring existing technical documentation to remove subjective claims and promotional wording.

03Standardizing project READMEs across multiple repositories to ensure consistent structure and metadata.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add cuioss/cui-llm-rules cui-documentation

For use in Claude.ai and ChatGPT

Download Skill