Category:Developing Qt::Documentation: Difference between revisions

Developing Qt Documentation

Qt documentation is written by a small global team of technical writers and developers working at The Qt Company, complemented by a number of contributors from other parts of the Qt community. Since different parts of Qt are developed in different locations, writers with expertise in those areas are typically co-located with those developers. For example, much of the documentation for Qt Creator is written in Berlin.

Qt's technical writers are also responsible for many of the examples provided with Qt and related projects. However, the demonstrations provided with these projects are typically created by developers, and these are often not intended to be documented or supported by the Qt documentation team.

The documents in this category aim to cover the many aspects of Qt documentation creation, including the process we use to accept contributions from other community members.

Documentation Snapshots

Currently, Qt documentation is hosted at three sites:

• http://doc.qt.io/ - Official documentation releases
• http://doc-snapshots.qt.io/ - Unreleased documentation from Qt source repositories
• http://doc.qt.digia.com/archives/ - Archive for legacy documentation

Contributing to Qt Documentation

Prerequisites

Here are the basic steps to help you get started contributing to the Qt documentation:

• Familiarize yourself with the development process. In particular, the process of contributing code.
• Create a JIRA account for https://bugreports.qt.io account and set up your Gerrit environment.
• Download the Qt sources.
• Read the page regarding code reviews.

QDoc and Style Guidelines

Qt's documentation tool is QDoc. QDoc scans through the source and generates html pages regarding the classes, enums, QML types, and other parts of the reference documentation.

To get started, the QDoc Manual explains how QDoc generates documentation from QDoc comments.

• http://doc.qt.io/qt-5/qdoc-index.html

QDoc Regression Testing

• QDocRegressionTesting

Writing Guidelines

• QtWritingGuidelines

Submitting a Patch

The process for submitting a documentation patch is the same as for source code. For more information, read the Code Reviews page.

Approvers and Editors

For language reviews, documentation reviews, and technical reviews, you may add any of the relevant maintainers as reviewers as well as the following individuals:
* Leena Miettinen (Qt Creator documentation maintainer)
* Geir Vattekar
* Jerome Pasion
* Venugopal Shivashankar
* Martin Smith
* Nico Vertriest
* Topi Reinio (Documentation maintainer)
* Sze Howe Koh

For language reviews (particularly for non-native English speakers) only, you may also add any of the following individuals:
* Mitch Curtis
* Lorn Potter

For documentation help, join the #qt-documentation channel in Freenode.

Filing Documentation Issues

Anybody with a https://bugreports.qt.io account may file a bug. For documentation bugs, please file the issue and enter Documentation AND the relevant library or module in the Component field. The process of fixing code bugs also apply to documentation issues.

Qt 5 Documentation

The organization and development of Qt 5 documentation is covered in another wiki: Qt5DocumentationProject

Documentation Structure

The Qt Documentation Structure page provides information about the structure of the documentation.