Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-123168

Update the structure of the QDoc manual to follow the diataxis framework

    XMLWordPrintable

Details

    • DaVinci 95, DaVinci 96, DaVinci 97, DaVinci 99, DaVinci 100, DaVinci 101, DaVinci 102, DaVinci 103, DaVinci 104, DaVinci 105, DaVinci 106, framework-content 1

    Description

      This is the start of a project to reorganise and update the QDoc manual.

      The current structure of the QDoc manual will be evaluated

      A new structure will be proposed based on the diataxis framework (Overview, How-to, Tutorials, References)

      The documentation team will review the proposed structure and give their opinions

      A final structure will be decided on.

       

      Attachments

        Issue Links

          relates to

          Task - A task that needs to be done. QTBUG-126679 Implementing Diataxis framework on Examples and Tutorials

          • Not Evaluated - Not yet evaluated/prioritized
          • Closed
          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              safiyyah Safiyyah Moosa
              safiyyah Safiyyah Moosa
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - 2 weeks
                  2w
                  Remaining:
                  Remaining Estimate - 2 weeks
                  2w
                  Logged:
                  Time Spent - Not Specified
                  Not Specified

                  Gerrit Reviews

                    There are no open Gerrit changes