Revision control
Copy as Markdown
# Qt Documentation Sources
## Content & Style Authority (WHAT to write)
### Tier 1 - Qt Official Standards (HIGHEST AUTHORITY)
**S1. Qt Writing Guidelines** (PRIMARY)
- Coordinates all Qt documentation standards
**S2. QUIP 25 - Qt Documentation Writing Style** (AUTHORITATIVE)
- Language, grammar, style, formatting
- "This QUIP is primary; Microsoft Writing Style Guide is optional"
**S3. C++ Documentation Style**
- C++ API documentation patterns
**S4. QML Documentation Style**
- QML API documentation patterns
**S5. Qt Examples Guidelines**
- Example code quality, zero warnings, screenshots
**S6. Writing Example Documentation and Tutorials**
- 11 mandatory elements for example documentation
**S7. Qt Terms and Concepts**
- Official Qt terminology definitions
**S8. Qt Alt Text Style**
- Path: ~/.claude/skills/skill-alttext/SKILL.md
- Alt text patterns, formatting, terminology
### Tier 2 - Supplementary Reference
**S9. Microsoft Style Guide**
- Used when Qt sources don't specify
## Tool & Syntax Reference (HOW to write it)
**S10. QDoc Manual**
- Local: qttools/src/qdoc/doc/qdoc-index.qdoc
- QDoc command syntax, not a style authority
## When to Consult Which Source
| Question | Source |
|----------|--------|
| Style ("active voice?") | S1 > S2 > S9 |
| C++ API patterns | S3 |
| QML API patterns | S4 |
| QDoc syntax | S10 |
| Terminology | S7 |
| Alt text | S8 |