Uploaded image for project: 'Docs for Red Hat Developers'
  1. Docs for Red Hat Developers
  2. RHDEVDOCS-1708

[LANGUAGE] Review and overhaul style and structure of Introduction to Eclipse Che

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Won't Do
    • Icon: Minor Minor
    • None
    • None
    • Eclipse Che
    • 8
    • Documentation (Ref Guide, User Guide, etc.)

      1. I ran the documentation through a couple of tools that analyze readability, the doc is scored from 9 to 13 (Flesch-Kincaid Grade Level, FORCAST Grade Level - the indexes that are used for tech writing), which is a) unacceptable for an Introductory text, b) does not reach the recommended throughout CCS 8 grade level,

      2. It contains a lot of non-technical "marketing" expressions - "great", "with a single click", "enjoyable", "easy" etc. IMO This info should be hosted on a https://www.eclipse.org/che/ website, not in the docs. Nothing wrong with a little bit of marketing but we have too much of it.

              Unassigned Unassigned
              yhontyk@redhat.com Yana Hontyk (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: