Category:Developing Qt::Documentation: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
No edit summary
(59 intermediate revisions by 14 users not shown)
Line 1: Line 1:
h1. Developing Qt Documentation
[[Category:Developing Qt]]


Qt documentation is written by a small global team of technical writers and developers working at Digia Plc, 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 expertize in those areas are typically co-located with those developers. For example, much of the documentation for Qt Creator and the Qt SDK 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 7: Line 7:
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.
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 ==
==Documentation Snapshots==


Currently, Qt documentation is hosted at three sites:<br />* &quot;Qt Project&amp;quot;:http://doc.qt.io/ - contains official releases<br />* &quot;Snapshot&amp;quot;:http://doc-snapshot.qt.io - contains unreleased documentation from the &quot;Codereview&amp;quot;:http://codereview.qt.io repositories<br />* &quot;Archives&amp;quot;:http://doc.qt.digia.com - contains legacy documentation
Currently, Qt documentation is hosted online at:


== Contributing to Qt Documentation ==
*[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.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.


=== Prerequisites ===
== Setting Up for Documentation Writing ==
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:<br /># Familiarize yourself with the [[Developing Qt | development process]]. In particular, [[Qt Contribution Guidelines | the process of contributing code]].<br /># Create a &quot;Jira&amp;quot;:https://bugreports.qt.io account and set up your [[Setting up Gerrit | Gerrit ]] environment.<br /># [[Get_The_Source | Download]] the Qt sources.<br /># Read the page regarding [[Code_Reviews | code reviews]].
#Familiarize yourself with the [[:Category:Developing_Qt | development process]]. In particular, [[Qt Contribution Guidelines | the process of contributing code]].
#Create a [https://bugreports.qt.io Jira] account and set up your [[Setting up Gerrit | Gerrit]] environment.
#[[Get_The_Source | Download]] the Qt sources.
#Read the page regarding [[Code_Reviews | code reviews]].
#Start by contributing small fixes. Don't hesitate to ask for help!


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


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<br />reference documentation.
*[http://doc-snapshots.qt.io/qt6-dev/qdoc-index.html QDoc Manual]
*[[QDocRegressionTesting]] - how to test the Qt documentation set
*[[Building Qt Documentation]]


* &quot;QDoc Manual&amp;quot;:http://doc-snapshot.qt.io/qdoc/
== Writing Guidelines ==


To get started, the &quot;QDoc Guide&amp;quot;:http://doc.qt.io/qt-5/qdoc-guide.html explains how QDoc generates documentation from QDoc comments.
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]]
== 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.


=== QDoc Regression Testing ===
For documentation reviews, you may add the following for reviews:
==== Qt Oslo - Qt Reference Documentation and QDoc: ====
* 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]]


* [[QDocRegressionTesting]]
==== 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)


=== Writing Guidelines ===
==== Qt Oulu - Qt Products ====
* Esa Törmänen (Qt for MCU documentation)
*Inkamari Harjula (Boot2Qt documentation)
*[[User:Johannavanhatapio|Johanna Vanhatapio]] (Qt Design Studio  documentation)
*[[User:Matshonkamaa|Mats Honkamaa]] (Qt Design Studio  documentation)
*[[User:Nicholasbennet|Nicholas Bennet]] (Platform documentation)
*Pranta Dastider (Qt Design Studio  documentation)
*Teea Põldsam (Qt Design Studio and Qt License Server documentation)
*


* [[QtWritingGuidelines]]
Also, the following people can help with English and technical reviews:


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


The process for submitting a documentation patch is the same as for source code. For more information, read the [[Code_Reviews | Code Reviews ]] page.
== 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.


==== Approvers and Editors ====
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 [http://doc-snapshots.qt.io/ doc-snapshots.qt.io]


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:<br />* Leena Miettinen (Qt Creator documentation maintainer)<br />* Geir Vattekar<br />* Jerome Pasion<br />* Venugopal Shivashankar<br />* Martin Smith<br />* Nico Vertriest<br />* Topi Reinio (Documentation maintainer)<br />* Sze Howe Koh
==Modular Qt Documentation==


For language reviews (particularly for non-native English speakers) only, you may also add any of the following individuals:<br />* Mitch Curtis<br />* Lorn Potter
The organization and development of modular Qt documentation is covered in another wiki: [[Qt5DocumentationProject]]


For documentation help, join the #qt-documentation channel in Freenode.
===Documentation Structure===
 
=== Filing Documentation Issues ===
 
Anybody with a &quot;Jira&amp;quot;: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.
 
The latest documentation snapshot is at &quot;http://doc-snapshot.qt.io/&amp;quot;:http://doc-snapshot.qt.io/
 
== Qt 5 Documentation ==
 
The organization and development of Qt 5 documentation is covered in another wiki: [[Qt5DocumentationProject]]
 
=== Documentation Structure ===


The [[Qt_Documentation_Structure | Qt Documentation Structure]] page provides information about the structure of the documentation.
The [[Qt_Documentation_Structure | Qt Documentation Structure]] page provides information about the structure of the documentation.

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"