Uploaded image for project: 'Quarkus Documentation'
  1. Quarkus Documentation
  2. QDOCS-22

Choose top style RH guidelines that Quarkus writers should apply to the community docs during phase 1

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Major Major
    • None
    • None
    • POC1-prework
    • None
    • 3
    • False
    • Hide

      None

      Show
      None
    • False
    • Red Hat build of Quarkus

      The RH and IBM style guides contain thousands of recommendations to help brand, style, and improve technical communication. Not all of the guidelines will work (or be welcomed) in the open-source community project.

      As a team of RH writers contributing to the upstream docs, we need to be consistent in our approach. 

      As a Quarkus docs team writer switching from the downstream docs to the upstream docs, I need clear guidance as to which bits of our style guides I should apply as a priority to my content development in the upstream community.

      This task is done when

      • All writers in the Quarkus docs team have identified the top style areas that we could add value to the community docs.
        • (we can use the security guide as a starting point to help us to prioritise which style guide items would add the most value.)
      • The writers have discussed the top 5 style areas with our CS, DPM, and the Quarkus Community doc leads and agreed on the items.

      This list will feed into the work to define a Quarkus Community docs style guide.

          There are no Sub-Tasks for this issue.

              142934-CCS-smanocha Sunayna Manocha
              mpurcell@redhat.com Michelle Purcell
              Heena Manwani, Michal Maléř, Michelle Purcell, Sheila Jones, Sreelatha Nelluli, Stefan Sitani (Inactive), Sunayna Manocha
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: