Hi, We propose an informational quip about Qt Documentation Style:
https://codereview.qt-project.org/c/meta/quips/+/678715 Clear and consistent writing is essential for Qt documentation. This document aims to define the writing style standards that ensure Qt documentation is professional, accessible, and easy to understand for users worldwide. The current QUIP aims to collect and formalize some of the advice that is currently spread across several wiki pages and ’shared wisdom’ among technical writers. As such, it is written agnostic to tooling. We will try to collect some more technical advice for QDoc and API documentation in a follow-up QUIP-26. Looking forward to the discussion 😊 Kai & Mats -- Kai Köhne, Director R&D | The Qt Company The Qt Company GmbH, Erich-Thilo-Str. 10, D-12489 Berlin Geschäftsführer: Mika Pälsi, Juha Varelius, Jouni Lintunen Sitz der Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 144331 B Confidential
-- Development mailing list [email protected] https://lists.qt-project.org/listinfo/development
