Category:Developing Qt::Documentation: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
 
(26 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Developing Qt]]
[[Category:Developing Qt]]


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 a particular area are typically co-located with the developers of that area. For example, the documentation for Qt Creator is written in Berlin.
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 a particular area are typically co-located with the developers of that area.


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.
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.
Line 9: Line 9:
==Documentation Snapshots==
==Documentation Snapshots==


Currently, Qt documentation is hosted at three sites:
Currently, Qt documentation is hosted online at:


*[http://doc.qt.io/ doc.qt.io]: contains official releases
*[http://doc.qt.io/ doc.qt.io]: contains official releases
*[http://doc-snapshots.qt.io/ snapshots]: contains unreleased documentation from the [http://codereview.qt-project.org/ Codereview] repositories
*[http://doc-snapshots.qt.io/ snapshots]: contains unreleased documentation from the [http://codereview.qt-project.org/ Codereview] repositories
*[http://doc.qt.io/archives/ archives]: contains legacy documentation
*[http://doc.qt.io/archives/ archives]: contains legacy documentation
Also, when installing a version of Qt and Qt Creator, an offline documentation set of that particular release is included.


==Contributing to Qt Documentation==
== Setting Up for Documentation Writing ==
 
Qt Project follows a 'docs as code' approach. That is, the documentation is maintained in the form of markup (qdoc), and is maintained
alongside the source code of the Qt modules and tools it is describing, using the same version control system and a similar
[[Qt Contribution Guidelines | contribution process]].
 
===Prerequisites===
 
Here are the basic steps to help you get started contributing to the Qt documentation:
Here are the basic steps to help you get started contributing to the Qt documentation:


Line 31: Line 25:
#Start by contributing small fixes. Don't hesitate to ask for help!
#Start by contributing small fixes. Don't hesitate to ask for help!


===Style and Language 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
Qt documentation adheres to the [https://docs.microsoft.com/en-us/style-guide/welcome/ Microsoft Style Guide]. The documentation follows American English grammar and spelling.
reference documentation. It is possible to create a documentation set for Qt modules and tools.
 
The [[Language_Guidelines | Language Guidelines]] page provides further information about idioms and usage, punctuation and grammar issues.
 
===QDoc===
 
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.


*[http://doc-snapshots.qt.io/qt6-dev/qdoc-index.html QDoc Manual]
*[http://doc-snapshots.qt.io/qt6-dev/qdoc-index.html QDoc Manual]
*[[QDocRegressionTesting]] - how to test the Qt documentation set
*[[Building Qt Documentation]]


To get started, the [http://doc.qt.io/qt-5/qdoc-guide.html QDoc Guide] explains how QDoc generates documentation from QDoc comments.
== Writing Guidelines ==
 
===QDoc Regression Testing===
 
*[[QDocRegressionTesting]]
 
===[[:Category:Writing Guidelines]]===


The Qt Writing Guidelines can with creating and editing Qt documentation. We adhere to it for consistency and to create a singular voice. We also follow the QUIP system and follow the requirements regarding examples and images.
*[[Qt Writing Guidelines]]
*[[Qt Writing Guidelines]]
== Getting Help with Editing ==
The process for submitting a documentation patch is the same as for source code. For more information, read the [[ Code Reviews]] page.


===Submitting a Patch===
For documentation reviews, you may add the following for reviews:
 
==== Qt Oslo - Qt Reference Documentation and QDoc: ====
The process for submitting a documentation patch is the same as for source code. For more information, read the [[Code_Reviews | Code Reviews]] page.
* David Boddie
* [[User:Andreaseliasson|Andreas Eliasson]]
* Safiyya Moosa
* Jerome Pasion
* [[User:Topireinio|Topi Reiniö]] (QDoc maintainer)
* [[User:Lucadisera|Luca Di Sera]]
* [[User:Venugopalshivashankar|Venugopal Shivashankar]]
* [[User:Paulwicking|Paul Wicking]]


Tip: Use [https://git-scm.com/docs/git-grep git grep] to find the file and line where existing documentation is maintained.
==== Qt Berlin - Qt Tools (Qt Creator, Qt Assistant, and others), Foundations team ====
* [[User:Leenamiettinen|Leena Miettinen]] (Qt Creator documentation maintainer)
* [[User:Jaishreevyas|Jaishree Vyas]] (Qt Foundations)


====Approvers and Editors====
==== Qt Oulu - Qt Products ====
 
* Esa Törmänen (Qt for MCU documentation)
For language reviews, documentation reviews, and technical reviews, you may add any of the relevant [[Maintainers | maintainers]] as reviewers as well as the following individuals:
 
*[[User:Andreaseliasson|Andreas Eliasson]]
*Esa Törmänen (Qt for MCU documentation)
*Inkamari Harjula (Boot2Qt documentation)
*Inkamari Harjula (Boot2Qt documentation)
*[[User:Jaishreevyas|Jaishree Vyas]] (Qt Foundations)
*[[User:Johannavanhatapio|Johanna Vanhatapio]] (Qt Design Studio  documentation)
*[[User:Johannavanhatapio|Johanna Vanhatapio]] (Qt Design Studio  documentation)
*[[User:Leenamiettinen|Leena Miettinen]] (Qt Creator documentation maintainer)
*[[User:Lucadisera|Luca Di Sera]]
*[[User:Matshonkamaa|Mats Honkamaa]] (Qt Design Studio  documentation)
*[[User:Matshonkamaa|Mats Honkamaa]] (Qt Design Studio  documentation)
*[[User:Nicholasbennet|Nicholas Bennet]] (Platform documentation)
*[[User:Nicholasbennet|Nicholas Bennet]] (Platform documentation)
*[[User:Paulwicking|Paul Wicking]]
*Pranta Dastider (Qt Design Studio  documentation)
*Pranta Dastider (Qt Design Studio  documentation)
*Safiyyah Moosa
*Teea Põldsam (Qt Design Studio and Qt License Server documentation)
*Teea Põldsam (Qt Design Studio and Qt License Server documentation)
*[[User:Topireinio|Topi Reiniö]] (QDoc maintainer)
*
*[[User:Venugopalshivashankar|Venugopal Shivashankar]]
*[[User:Szehowekoh|Sze Howe Koh]]


For language reviews (particularly for non-native English speakers) only, you may also add any of the following individuals:
Also, the following people can help with English and technical reviews:


*Mitch Curtis
*Mitch Curtis
*Lorn Potter
*Lorn Potter
*[[User:EdwardWelbourne|Edward Welbourne]]
*[[User:EdwardWelbourne|Edward Welbourne]]
*[[User:JKSH|Sze Howe Koh]]


For documentation help, join the #qt-documentation channel in Freenode.
== Filing Documentation Issues ==
 
Anybody with a [https://bugreports.qt.io/ Jira] account may file a bug. For documentation bugs, please file the issue and fill in the '''Component''' field with '''Documentation''' ''and'' the relevant Qt library or tool. The process of fixing code bugs also apply to documentation issues.
===Filing Documentation Issues===
 
Anybody with a [https://bugreports.qt.io/ Jira] 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.


Before filing an issue, please check that it has not already been fixed in a later version of the documentation.
Before filing an issue, please check that it has not already been fixed in a later version of the documentation.

Latest revision as of 15:02, 14 November 2024


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 a particular area are typically co-located with the developers of that area.

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 online at:

Also, when installing a version of Qt and Qt Creator, an offline documentation set of that particular release is included.

Setting Up for Documentation Writing

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

  1. Familiarize yourself with the development process. In particular, the process of contributing code.
  2. Create a Jira account and set up your Gerrit environment.
  3. Download the Qt sources.
  4. Read the page regarding code reviews.
  5. Start by contributing small fixes. Don't hesitate to ask for help!

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. It is possible to create a documentation set for Qt modules and tools.

Writing Guidelines

The Qt Writing Guidelines can with creating and editing Qt documentation. We adhere to it for consistency and to create a singular voice. We also follow the QUIP system and follow the requirements regarding examples and images.

Getting Help with Editing

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

For documentation reviews, you may add the following for reviews:

Qt Oslo - Qt Reference Documentation and QDoc:

Qt Berlin - Qt Tools (Qt Creator, Qt Assistant, and others), Foundations team

Qt Oulu - Qt Products

  • Esa Törmänen (Qt for MCU documentation)
  • Inkamari Harjula (Boot2Qt documentation)
  • Johanna Vanhatapio (Qt Design Studio documentation)
  • Mats Honkamaa (Qt Design Studio documentation)
  • Nicholas Bennet (Platform documentation)
  • Pranta Dastider (Qt Design Studio documentation)
  • Teea Põldsam (Qt Design Studio and Qt License Server documentation)

Also, the following people can help with English and technical reviews:

Filing Documentation Issues

Anybody with a Jira account may file a bug. For documentation bugs, please file the issue and fill in the Component field with Documentation and the relevant Qt library or tool. The process of fixing code bugs also apply to documentation issues.

Before filing an issue, please check that it has not already been fixed in a later version of the documentation. The latest documentation snapshots are at doc-snapshots.qt.io

Modular Qt Documentation

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

Documentation Structure

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

Subcategories

This category has only the following subcategory.

W

Pages in category "Developing Qt::Documentation"

The following 5 pages are in this category, out of 5 total.

B

Q

T

Retrieved from "https://wiki.qt.io/index.php?title=Category:Developing_Qt::Documentation&oldid=43202"