Documentation Workshop 2019
Oslo, Norway - Qt offices
Date and time
11-12 March 2019, 10:00-17:00
A two-day workshop about the state of Qt's documentation. The aim is to get a clearer high-level vision for the docs, and establish a few key actions to proceed with to make that vision a part of reality.
- How to renew, drop, and create new examples?
- Does QUIP-13, Examples and Demos (https://codereview.qt-project.org/#/c/246288/) cover this, or do we need further criteria/instructions for internal use?
- What do we want to achieve with examples/demos/tutorials? What are the objectives for the user to learn from each example?
- How do these relate to the certification process we have?
- How to create examples, tutorials, which explain why something is implemented in a certain way?
- How to categorize/prioritize examples and tutorials?
- Qt Creator vs. our own structure within the documentation
- Learning track(s) for different topics/technologies (certification as a goal?)
- How to create even better tutorials for first comers?
- For example, Hello World, which really explains how to add modules, headers, source files, and other resources.
- How much of this can/should be covered by Qt Creator's Wizards?
- How to improve the usability of the documentation?
- Usability of online and offline documentation
- Utilizing Analytics and/or User studies?