| <?xml version="1.0" encoding="UTF-8"?> |
| <org.eclipse.epf.uma:ContentDescription xmi:version="2.0" |
| xmlns:xmi="http://www.omg.org/XMI" xmlns:org.eclipse.epf.uma="http://www.eclipse.org/epf/uma/1.0.5/uma.ecore" |
| xmlns:epf="http://www.eclipse.org/epf" epf:version="1.5.0" xmlns:rmc="http://www.ibm.com/rmc" |
| rmc:version="7.5.0" xmi:id="-OjWXYjOE5a7KQfU1TY5N4w" |
| name="reviewing_methods,_iFoK0MrGEdyOGKOa5tPdeg" guid="-OjWXYjOE5a7KQfU1TY5N4w" |
| changeDate="2008-09-11T19:09:58.187-0700" version="7.2.0"> |
| <mainDescription><p>
 |
| When reviewing a method, it is important to examine the method realization in authored and published form, as well as
 |
| any supporting documentation.
 |
| </p>
 |
| <p>
 |
| The following are some general things to consider when reviewing authored content:
 |
| </p>
 |
| <p>
 |
| Ensure that there is an acceptable level of quality in content prior to releasing that content for initial customer
 |
| evaluation. This is a list of proposed reviews that should be performed on the content before it can be considered
 |
| ready for initial release.
 |
| </p>
 |
| <ul>
 |
| <li>
 |
| Review for readability and consistent voice 
 |
| <ul>
 |
| <li>
 |
| Make sure the authoring guidelines have been adhered to.
 |
| </li>
 |
| <li>
 |
| Check the visual layout/flow of text<br />
 |
| &nbsp;
 |
| </li>
 |
| </ul>
 |
| </li>
 |
| <li>
 |
| Review for content correctness and consistency
 |
| </li>
 |
| <li style="LIST-STYLE-TYPE: none">
 |
| <ul>
 |
| <li>
 |
| Review the content focusing on a vertical slice, such as per process, per scenario, and so on.
 |
| </li>
 |
| <li>
 |
| Make sure the content has appropriate links to other content<br />
 |
| &nbsp;&nbsp;
 |
| </li>
 |
| </ul>
 |
| </li>
 |
| <li>
 |
| Copy-edit review<br />
 |
| &nbsp;&nbsp;
 |
| </li>
 |
| <li>
 |
| Review for usability
 |
| </li>
 |
| <li style="list-style: none">
 |
| <ul>
 |
| <li>
 |
| Check the layout of the navigation views
 |
| </li>
 |
| <li>
 |
| Make sure that a critical portion of guidance is "above the fold", meaning it can be seen on main portion
 |
| of the screen without need for scrolling the page down.
 |
| </li>
 |
| <li>
 |
| User scenarios: Have the reviewers put themselves in one or more roles below and try to accomplish the
 |
| actions described.&nbsp; For example:
 |
| </li>
 |
| <li style="list-style: none">
 |
| <ul>
 |
| <li>
 |
| See if the project manager can use the content to plan the project
 |
| </li>
 |
| <li>
 |
| See if the developer can find specific content
 |
| </li>
 |
| <li>
 |
| See if process engineer can customize the content by adding company-specific content
 |
| </li>
 |
| <li>
 |
| See if a first time user can easily&nbsp;navigate and follow the process (is there enough
 |
| introductory content)
 |
| </li>
 |
| </ul>
 |
| </li>
 |
| </ul>
 |
| </li>
 |
| </ul></mainDescription> |
| </org.eclipse.epf.uma:ContentDescription> |
