Uploaded image for project: 'Red Hat 3scale API Management'
  1. Red Hat 3scale API Management
  2. THREESCALE-10858

Updates and improvements to the 3scale API Management documentation books

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Unresolved
    • Icon: Major Major
    • None
    • None
    • Documentation
    • None
    • Red Hat 3scale API Management Documentation Improvements
    • 3
    • False
    • None
    • False
    • Not Started
    • Not Started
    • Not Started
    • Not Started
    • Not Started
    • Not Started
    • To Do
    • 0
    • 0% 0%

      This is a 3scale documentation effort to improve the content by making the following kinds of updates:

      NB: The issue listed in this Epic are for the 3scale Docs team only. We do not want to create issues that require SME/QE input.

      Note also the Release Notes are not included. This is because at the moment there is a CCS-wide initiative to improve and make the Release Notes consistent across docs.
       
      Reference: Peer review checklist

      Language

      • Checking for consistency
      • Use of gerunds
      • Grammar and Spelling Corrections
      • Correct word usage and entity naming
      • Correct use of acronyms and abbreviations
      • Terms and constructions

      Style

      • Passive voice
      • Tense
      • Titles
      • Numbers
      • Formatting

      Minimalism

      • Customer focus and action orientation
      • Scannability/Findability
      • Overly long sentences
      • Conciseness (no fluff)

      Usability

      • Content
      • Accessibility
      • Links
      • Visual continuity

      Structure

      Modularization

      dfenness@redhat.com and rhn-support-lcavalle will drive this effort separately, in parallel to the above.

      • Structure meets modular guidelines
      • A logical flow of information
      • User stories

            dfenness@redhat.com Darren Fennessy
            dfenness@redhat.com Darren Fennessy
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated: