Uploaded image for project: 'Docs for Red Hat Developers'
  1. Docs for Red Hat Developers
  2. RHDEVDOCS-6990 CQA 2.0: Quality - Work with builds
  3. RHDEVDOCS-6994

Quality Assessment: Content uses simple words

XMLWordPrintable

    • Icon: Sub-task Sub-task
    • Resolution: Done
    • Icon: Normal Normal
    • None
    • None
    • builds-openshift-layered-docs
    • None
    • 2
    • ---
    • ---

      Output Format: Identify and list instances of unnecessarily complex vocabulary, jargon that isn't defined, or overly academic phrasing. Provide examples of such words or phrases and suggest simpler alternatives where appropriate.

      Instances of unnecessarily complex vocabulary, jargon that isn't defined, or overly academic phrasing:

      Term/Phrase Location Suggestion
      OCI artifact Assembly B abstract, Module title Provide a brief, parenthetical definition immediately upon first use, as it is complex jargon.
      egress gateway Assembly A abstract While technically accurate for the audience, ensuring it is consistently understood as the outgoing network proxy is critical.

              rhn-support-ssathe Shivani Sathe
              rhn-support-ssathe Shivani Sathe
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: