skill-language-style

Codify Qt documentation language, grammar, and style guidelines for C++ and QML.

19|29|Updated May 6, 2013
One-click install
npx skills add https://github.com/qt/qtqa --skill skill-language-style
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: skill-language-style
Source: https://github.com/qt/qtqa/tree/main/documentation_review/skills/skill-language-style
Command: npx skills add https://github.com/qt/qtqa --skill skill-language-style

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Qt documentation often suffers from inconsistent language, terminology, and formatting across API references, guides, and examples. This Skill provides a centralized language and style framework to harmonize writing across the Qt documentation ecosystem.

Core Features & Use Cases

  • Establishes terminology usage guidelines and voice rules (active vs passive, present tense).
  • Consolidates QDoc command usage and API documentation patterns for C++ and QML.
  • Provides references to official sources and a roadmap for future style cleanups.

Quick Start

Apply the Skill's frontmatter-driven guidelines to create or validate new Qt documentation pages.

Frequently Asked Questions about skill-language-style

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

FAQPage Schema
How do I maintain consistent terminology and formatting across Qt documentation?

To maintain consistent terminology and formatting across Qt documentation, apply centralized language, grammar, and style guidelines that establish voice rules and consolidate QDoc command patterns for C++ and QML API pages.

What are the language and style guidelines for writing Qt documentation?

Qt documentation language and style guidelines mandate active voice, present tense, and specific terminology usage, consolidating QDoc command patterns to harmonize writing across API references, guides, and tutorials.

Does this Qt style framework apply to both C++ and QML API pages?

Yes, this Qt style framework applies to both C++ and QML API documentation, consolidating command usage and API documentation patterns to enforce consistent terminology and voice across all Qt docs.

How do I validate new Qt documentation pages against official style rules?

You validate new Qt documentation pages by applying frontmatter-driven guidelines that check for established terminology, active voice, present tense, and correct QDoc command usage to ensure compliance before publishing.

What is the best way to standardize QDoc command usage in Qt documentation?

The best way to standardize QDoc command usage is to apply a centralized style framework that consolidates API documentation patterns and provides references to official sources for consistent rule application across guides and examples.

Do I need a valid SKILL.md frontmatter to use Qt documentation style guidelines?

Yes, applying these Qt documentation style guidelines requires a valid SKILL.md frontmatter with a name and description, and optionally references, scripts, and assets to support rule definitions and source citations.