cui-documentation

Enforce CUI documentation standards for README, AsciiDoc, and technical docs.

1|Updated Feb 3, 2025
One-click install
npx skills add https://github.com/cuioss/cui-llm-rules --skill cui-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: cui-documentation
Source: https://github.com/cuioss/cui-llm-rules/tree/main/claude/marketplace/bundles/cui-documentation-standards/skills/cui-documentation
Command: npx skills add https://github.com/cuioss/cui-llm-rules --skill cui-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides general documentation standards for README, AsciiDoc, and technical docs, with guidance to maintain tone, structure, and quality.

Core Features & Use Cases

  • Documentation Core: Tone, style, organization, and formatting guidelines.
  • AsciiDoc & Readme: Structured formatting, cross-referencing, and linking patterns.
  • Quality & Review: Documentation verification and style convergence.

Quick Start

Load the cui-documentation standards when creating project docs and run checks to ensure consistency.

Frequently Asked Questions about cui-documentation

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

FAQPage Schema
How do I enforce consistent documentation standards across README and AsciiDoc files?

Documentation standards for CUI projects enforce tone, style, organization, and formatting consistency across README, AsciiDoc, and technical docs. Load core standards, validate header attributes (TOC, section numbering, language tags), verify cross-reference syntax, ensure proper list formatting, and confirm code examples match unit tests.

What AsciiDoc formatting rules should I follow for CUI project documentation?

CUI documentation standards require proper header attributes, blank lines before lists, correct nested list formatting, accurate code block language tagging, and valid cross-reference syntax. Validate section numbering, source-highlighter configuration, and ensure references point to existing targets.

How do I review documentation quality and maintain consistent tone across technical docs?

Run documentation verification checks to analyze quality, tone, organization, and formatting against CUI standards. Extract key requirements into working memory, validate structure and cross-references, confirm code samples derive from unit tests, and ensure style convergence across all documentation.

Can I use CUI documentation standards for creating new project README files?

Yes. CUI documentation standards apply to create, edit, review, or restructure README and technical documentation tasks. Load core and context standards, apply tone and style guidelines, validate AsciiDoc formatting, verify cross-references, and ensure code examples meet quality requirements.

What should I check when validating code samples in documentation?

Verify code examples come from unit tests, use accurate language tagging in code blocks, maintain proper formatting, and ensure examples remain current with source code. Validate block syntax and confirm all referenced code paths exist.