QtCS25 - Team-Driven Documentation: Difference between revisions
No edit summary |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
==Session Summary== | ==Session Summary== | ||
' | We've already improved the documentation usability by adding a navigation tree, translations, and the feedback form (you can see these improvements on https://doc.qt.io/qt-6/index.html). I think we can focus now on the documentation completeness, relevance... you know, ''quality''. But this may require a couple of tunings in our code review workflow. | ||
==Session Owners== | ==Session Owners== | ||
Alexei Cazacov, Senior Technical Writer (Qt Framework) | |||
==Notes== | |||
A collaborative approach can help us create documentation of a better quality. We can make it a habit to assign a technical writer as a reviewer to each commit that contains doc changes. The ideas are: | |||
- Create a "Doc Review" label in Gerrit. The label is added only to the commits with doc changes and does not prevent a commit from being submitted. | |||
- Tune the bot in Gerrit, so it automatically adds the beforementioned label. | |||
The label can serve as a reminder for an approver to request a review from a technical writer to ensure the new content is in a good shape. | |||
[[File:QCS25 - Documentation.pdf|thumb]] | |||
[[Category:QtCS2025]] | [[Category:QtCS2025]] | ||
Latest revision as of 14:43, 8 May 2025
Session Summary
We've already improved the documentation usability by adding a navigation tree, translations, and the feedback form (you can see these improvements on https://doc.qt.io/qt-6/index.html). I think we can focus now on the documentation completeness, relevance... you know, quality. But this may require a couple of tunings in our code review workflow.
Session Owners
Alexei Cazacov, Senior Technical Writer (Qt Framework)
Notes
A collaborative approach can help us create documentation of a better quality. We can make it a habit to assign a technical writer as a reviewer to each commit that contains doc changes. The ideas are:
- Create a "Doc Review" label in Gerrit. The label is added only to the commits with doc changes and does not prevent a commit from being submitted.
- Tune the bot in Gerrit, so it automatically adds the beforementioned label.
The label can serve as a reminder for an approver to request a review from a technical writer to ensure the new content is in a good shape.
