Eclipse Community Forums: EPF » Content Reviewing Ideas

Home » Archived » EPF » Content Reviewing Ideas

Content Reviewing Ideas [message #23650]

Tue, 14 November 2006 14:17

Eclipse User

The following is a list of "test ideas" for reviewing process content.
These may also be incorporated into the way we validate content for
OpenUP and other processes. Comments are welcome.

Jim Ruehlin
jruehlin@us.ibm.com

*Test (Reviewing) Ideas*

_Review for readability and consistent voice_

Follow the authoring guidelines

Passive sentences, grammar errors, improper use of terms, etc

Keep descriptions focused on results, not artifacts

/E.g. the purpose of some activity is to gain agreement on something,
which may involve creating the Vision, rather than develop the vision
artifact./

Visual layout/flow of text

Break up long, intimidating blocks of text. Indent, use bullets, replace
descriptions with images, etc.

_Review for content consistency_

Discipline focus

Role focus

Phase focus

Content has appropriate links to other content

/E.g. concepts about phases reference guidance on how to
rapidly/successfully complete the phase./

Adherence to “OpenUP required fields”

We need to look across process and define some OpenUP- specific
authoring guidance such as “Every item of type <x> should have values in
fields <y> and <z>”.

1 or 2 templates for each work product

_Copy edit review_

_Review for content correctness_

Content has been successfully used in real projects

Each role and artifact listed in a task (required/optional,
input/output) is referenced in the task steps

_Review for usability_

Browser layout

Critical portion of guidances are "above the fold"

Avoid long intimidating blocks of text

Break up using formatting

Substitute images for text

Text length guidelines

Guidances are usually 1-3 screens

Task steps are usually 1-3 sentences

Whitepapers are 3-10 pages

User scenarios

PM trying to use process as-is

Developer referencing content on patterns

Architect trying to formally define the architecture

PM trying to justify an approach to management

Process engineer adding lots of company specific content

Tester adding test guidance specific to a project type

etc

_Review for Principles and Practices_

/Assure all content elements and processes reflect the fundamental
principles of the process. At a minimum, they can't contradict the
principles./

OpenUP practices should be reified in tasks

Re: Content Reviewing Ideas (better format) [message #23697 is a reply to message #23650]

Tue, 14 November 2006 14:18

Eclipse User

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html;charset=windows-1252"
http-equiv="Content-Type">
</head>
<body bgcolor="#ffffff" text="#000000">
Test (Reviewing)
Ideas
Review for
readability and consistent voice
Follow the
authoring guidelines
Passive
sentences, grammar errors, improper use of terms, etc
Keep
descriptions focused on results, not artifacts
E.g. the purpose of some
activity is to gain agreement on something, which may involve creating
the
Vision, rather than develop the vision artifact.<o:p></o:p>
Visual
layout/flow of text
Break up long, intimidating blocks of text.
Indent,
use bullets, replace descriptions with images, etc.<o:p></o:p>
Review for
content consistency
Discipline focus
Role focus
Phase focus
Content has
appropriate links to other content
E.g. concepts about phases
reference guidance on how to rapidly/successfully complete the phase.<o:p></o:p>
Adherence to
“OpenUP required fields”
We need to look
across process and
define some OpenUP- specific authoring guidance such as “Every item of
type
<x> should have values in fields <y> and <z>”.<o:p></o:p>
1 or 2
templates for each work product
Copy edit review
Review for
content correctness
Content has
been successfully used in real projects
Each role and
artifact listed in a task (required/optional, input/output) is
referenced in
the task steps
Review for
usability
Browser layout
Critical
portion of guidances are "above the fold"
Avoid long
intimidating blocks of text
Break up using
formatting
Substitute
images for text
Text length
guidelines
Guidances are
usually 1-3 screens
Task steps are
usually 1-3 sentences
Whitepapers
are 3-10 pages
User scenarios
PM trying to
use process as-is
Developer
referencing content on patterns
Architect
trying to formally define the architecture
PM trying to
justify an approach to management
Process
engineer adding lots of company specific content
Tester adding
test guidance specific to a project type
etc
Review for
Principles and Practices
Assure all
content elements and processes reflect the fundamental principles of
the
process. At a minimum, they can't contradict the principles.<o:p></o:p>
OpenUP
practices should be reified in tasks
<o:p> </o:p>
<o:p> </o:p>
</body>
</html>

Re: Content Reviewing Ideas (better format) [message #568551 is a reply to message #23650]

Tue, 14 November 2006 14:18

Eclipse User

Previous Topic:	Content Reviewing Ideas
Next Topic:	Please Provide Feedback on OpenUP

Goto Forum:

-=] Back to Top [=-

Current Time: Mon Apr 28 01:41:49 EDT 2025

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter