[jbosstools-issues] [JBoss JIRA] (JBTIS-1004) Integration Stack Installation Guide peer review

[Nick Boldt (JIRA)]

     [ https://issues.jboss.org/browse/JBTIS-1004?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Nick Boldt updated JBTIS-1004:
------------------------------
           Project: JBoss Tools Integration Stack  (was: Red Hat JBoss Developer Studio (devstudio))
               Key: JBTIS-1004  (was: JBDS-4220)
    Docs QE Status:   (was: NEW)
       Component/s: distribution
                    testing
                        (was: documentation)
                        (was: integration-platform)
            Writer:   (was: Misha Ali)


> Integration Stack Installation Guide peer review
> ------------------------------------------------
>
>                 Key: JBTIS-1004
>                 URL: https://issues.jboss.org/browse/JBTIS-1004
>             Project: JBoss Tools Integration Stack
>          Issue Type: Bug
>          Components: distribution, testing
>            Reporter: Gemma Sheldon
>            Priority: Minor
>             Fix For: 10.0.0.GA
>
>
> General peer review stuff from the JBDIS Installation Guide.
> *Chapter 2:*
> - Oxford comma after "architecture" in the first para.
> *Chapter 4:*
>  - "At the Select Additional Features to Install screen, select the required components: "
> This could be "Select the required components from the Select Additional Features to Install screen"?
>  - "When done, JBoss Developer Studio Integration Stack and the integration stack components are ready to use. "
> When complete? Once installed?
>  - In Warning "The IDE changes do not take effect until the IDE is restarted and the IDE may be unstable until it is restarted. "
> Kind of awkward as IDE is repeated x3 and restarted is there twice. Maybe:
> The IDE changes are not applied until it is restarted. The IDE may be unstable until it is restarted and the changes take effect.
> *Chapter 6*
>  - The sub-steps here could use a full stop based on the IBM style guide pp84-85.
>  - Same Warning as in previous chapter
> *Chapter 7*
>  - Same point about the sub-steps and full stops. Some have them here, some don't.
>  - Before the last Important is missing a full stop. "For plug-in specific configuration information, see the appropriate Red Hat JBoss product documentation available from the Red Hat Customer Portal"
> *Chapter 8*
>  - Several steps throughout the procedure are missing full stops at the end.
>  - Step 2 "optional" should probably be capitalized. I'm not 100% sure of this, but it seems awkward being lower case at the beginning of a step.
>    - Same as above with Step 6, which is also missing the opening bracket.
>  - Same Warning as in Chapters 5 and 6.
> - "Click Yes to restart immediately and No if you need to save any unsaved changes to open projects. " I think using saved and unsaved together here is awkward. I would just say "If you need to save any changes to open projects." 
> This statement also appears in Chapter 6.
> *Chapter 9*
>  - "Removing one or more plug-ins that are no longer required provides continued stability and ensures continued optimal performance due to a smaller memory footprint."
> 2x continued here. Could be "... provides continued stability and ensures optimal performance..."
> - " in an efficient manner" --> efficiently.
>  - full stops at the end of the bullet points.
>  - substeps of step 4 are missing full stops.



--
This message was sent by Atlassian JIRA
(v7.2.3#72005)