Design documentation topics

Design standard doc pages.

Start page

What information will the users see first and how can they navigate to other parts of the document?

https://doc-snapshots.qt.io/qtcreator-master/index.html

Other current examples of tools manual front pages:

• https://doc-snapshots.qt.io/qtdesignstudio/index.html
• https://doc-snapshots.qt.io/vstools-dev/index.html
• https://doc-snapshots.qt.io/qt6-dev/qtlinguist-index.html

How To page

A collection page for how-to topics. How should the topics be grouped and presented to users?

https://doc-snapshots.qt.io/qtcreator-master/creator-how-tos.html 

Reference page

A collection page for reference topics. How should the topics be grouped and presented to users?

https://doc-snapshots.qt.io/qtcreator-master/creator-reference.html

Mode or extension reference page

A page that describes a mode or extension. What information do the users need and how should it be presented to them?

• https://doc-snapshots.qt.io/qtcreator-master/creator-quick-tour.html
• https://doc-snapshots.qt.io/qtcreator-master/creator-scxml.html
• https://doc-snapshots.qt.io/qtcreator-master/creator-modeling.html