Category:Developing Qt::Documentation: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
No edit summary
 
 
(62 intermediate revisions by 14 users not shown)
Line 1: Line 1:
=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 <span class="caps">SDK</span> 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.


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.
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/ Qt Project] ''[qt.io]'' – contains official releases
*[http://doc.qt.io/ doc.qt.io]: contains official releases
* [http://doc-snapshot.qt.io Snapshot] ''[doc-snapshot.qt.io]'' – contains unreleased documentation from the [http://codereview.qt.io Codereview] ''[codereview.qt.io]'' repositories
*[http://doc-snapshots.qt.io/ snapshots]: contains unreleased documentation from the [http://codereview.qt-project.org/ Codereview] repositories
* [http://doc.qt.digia.com Archives] ''[doc.qt.digia.com]'' – 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==
 
===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:


# Familiarize yourself with the [[Developing-Qt|development process]]. In particular, [[Qt-Contribution-Guidelines|the process of contributing code]].
#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] ''[bugreports.qt.io]'' account and set up your [[Setting-up-Gerrit|Gerrit]] environment.
#Create a [https://bugreports.qt.io Jira] account and set up your [[Setting up Gerrit | Gerrit]] environment.
# [[Get The Source|Download]] the Qt sources.
#[[Get_The_Source | Download]] the Qt sources.
# Read the page regarding [[Code Reviews|code reviews]].
#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, <span class="caps">QML</span> types, and other parts of the <br /> reference documentation.
 
* [http://doc-snapshot.qt.io/qdoc/ QDoc Manual] ''[doc-snapshot.qt.io]''
 
To get started, the [http://doc-snapshot.qt.io/qt5-stable/qdoc/qdoc-guide.html QDoc Guide] ''[doc-snapshot.qt.io]'' explains how QDoc generates documentation from QDoc comments.
 
===QDoc Regression Testing===
 
* [[QDocRegressionTesting]]
 
===Writing Guidelines===
 
* [[QtWritingGuidelines]]


===Submitting a Patch===
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.


The process for submitting a documentation patch is the same as for source code. For more information, read the [[Code Reviews]] page.
*[http://doc-snapshots.qt.io/qt6-dev/qdoc-index.html QDoc Manual]
*[[QDocRegressionTesting]] - how to test the Qt documentation set
*[[Building Qt Documentation]]


====Approvers and Editors====
== Writing Guidelines ==


For language reviews, documentation reviews, and technical reviews, you may add any of the relevant [[maintainers]] as reviewers as well as the following individuals:
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.


* Leena Miettinen (Qt Creator documentation maintainer)
For documentation reviews, you may add the following for reviews:
* Geir Vattekar
==== Qt Oslo - Qt Reference Documentation and QDoc: ====
* Jerome Pasion
* David Boddie
* Venugopal Shivashankar
* [[User:Andreaseliasson|Andreas Eliasson]]
* Martin Smith
* Safiyya Moosa
* Nico Vertriest
* Jerome Pasion
* Topi Reinio (Documentation maintainer)
* [[User:Topireinio|Topi Reiniö]] (QDoc maintainer)
* [[User:Lucadisera|Luca Di Sera]]
* [[User:Venugopalshivashankar|Venugopal Shivashankar]]
* [[User:Paulwicking|Paul Wicking]]


For language reviews (particularly for non-native English speakers) only, you may also add any of the following individuals:
==== 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)


* Mitch Curtis
==== Qt Oulu - Qt Products ====
* Lorn Potter
* 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)
*


For documentation help, join the #qt-documentation channel in Freenode.
Also, the following people can help with English and technical reviews:


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


Anybody with a [https://bugreports.qt.io Jira] ''[bugreports.qt.io]'' account may file a bug. For documentation bugs, please file the issue and enter ''Documentation'' '''<span class="caps">AND</span>''' the relevant library or module in the Component field. 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 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.


The latest documentation snapshot is at http://doc-snapshot.qt.io/ ''[doc-snapshot.qt.io]''
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]


==Qt 5 Documentation==
==Modular Qt Documentation==


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


===Documentation Structure===
===Documentation Structure===


The [[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.
 
===There are 9 articles in "Developing_Qt -&gt; Documentation":===
 
===B===
* [[Building Qt Documentation|Building_Qt_Documentation]]
* [[Building Qt Documentation Japanese|Building_Qt_Documentation_Japanese]]
* [[Building Qt Documentation Korean|Building_Qt_Documentation_Korean]]
* [[Building Qt Documentation Russian|Building_Qt_Documentation_Russian]]
* [[Building Qt Documentation SimplifiedChinese|Building_Qt_Documentation_SimplifiedChinese]]===I===
* [[Integrating Qt Examples SimplifiedChinese|Integrating_Qt_Examples_SimplifiedChinese]]===Q===
* [[Qt Example Coverage|Qt_Example_Coverage]]===S===
* [[Spelling Module Names in Qt Documentation|Spelling_Module_Names_in_Qt_Documentation]]===T===
* [[Troubleshooting Qt Documentation|Troubleshooting_Qt_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"