blob: e772a4f1d6e4cd0bb513ae8dc210d94fa9d4b889 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="copyright" content="(C) Copyright Eclipse contributors 2005, 2006" />
<meta name="DC.rights.owner" content="(C) Copyright Eclipse contributors 2005, 2006" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="concept" />
<meta name="DC.Title" content="Guidance" />
<meta name="DC.Relation" scheme="URI" content="createguidance.html#createguidance" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="guidance" />
<meta name="DC.Language" content="en-us" />
<!--
Copyright (c) 2005, 2006 IBM Corporation and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html
Contributors:
IBM Corporation - initial implementation
-->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<title>Guidance</title>
</head>
<body id="guidance"><a name="guidance"><!-- --></a>
<h1 class="topictitle1">Guidance</h1>
<div><div class="p">Guidance is a general term for additional information related to <a href="role.html#role">roles</a>, <a href="task.html#task">tasks</a>, and <a href="workproduct.html#workproduct">work products</a>. Examples of guidance are:<ul><li><strong><span class="keyword">Guideline</span></strong> - Provides additional detail on how
to perform a particular task or grouping of tasks, or that provides additional
detail, rules, and recommendations on work products and their properties.
Amongst others, it can include details about best practices and different
approaches for doing work, how to use particular types of work products, information
on different subtypes and variants of the work product and how they evolve
throughout a lifecycle, discussions on skills the performing roles should
acquire or improve upon, and measurements for progress and maturity.<p></p>
</li>
<li><strong><span class="keyword">Template</span></strong> - A specific type of guidance that
provides for a work product a predefined table of contents, sections, packages,
and/or headings, a standardized format, as well as descriptions how the sections
and packages are supposed to be used and completed. Templates cannot only
be provided for documents, but also for conceptual models or physical data
stores.<p></p>
</li>
<li><strong><span class="keyword">Checklist</span></strong> - A specific type of guidance that
identifies a series of items that need to be completed or verified. Checklists
are often used in reviews such as walkthroughs or inspections.<p></p>
</li>
<li><strong><span class="keyword">Tool Mentor</span></strong> - A specific type of guidance that
shows how to use a specific tool to accomplish some piece of work, either
in the context of, or independent from, a task or activity.<p></p>
</li>
<li><strong><span class="keyword">Supporting Material</span></strong> - Used as a catch all for
other types of guidance not specifically defined elsewhere. It can be related
to all kinds of content elements, including other guidance elements.<p></p>
</li>
<li><strong><span class="keyword">Report</span></strong> - A predefined template of a result that
is generated on the basis of other work products as an output from some form
of tool automation. An example for a report would be a use case model survey,
which is generated by extracting diagram information from a graphical model
and textual information from documents and combines these two types of information
into a report.<p></p>
</li>
<li><strong><span class="keyword">Concept</span></strong> - A specific type of guidance that outlines
key ideas associated with basic principles underlying the referenced item.
Concepts normally address more general topics than guidelines and span across
several work product and/or tasks or activities.<p></p>
</li>
<li><strong><span class="keyword">Practice</span></strong> - Represents a proven way or strategy
of doing work to achieve a goal that has a positive impact on work product
or process quality. Practices are defined orthogonal to methods and processes.
They could summarize aspects that impact may different parts of a method or
specific process. <p></p>
</li>
<li><strong><span class="keyword">Reusable Asset</span></strong> - Provides a solution to a problem
for a given context. The asset may have a variability point, which is a location
in the asset that may have a value provided or customized by the asset consumer.
The asset has rules for usage which are the instructions describing how the
asset should be used.<p></p>
</li>
<li><strong><span class="keyword">Term Definition</span></strong> - Defines concepts and is used
to build up the Glossary. A term definition is not directly related to content
elements, but its relationship is being derived when the term is used in the
content elements description text.<p></p>
</li>
<li><strong><span class="keyword">White Paper</span></strong> - A special concept guidance that
has been external reviewed or published and can be read and understood in
isolation of other content elements and guidance.<p></p>
</li>
<li><strong><span class="keyword">Example</span></strong> - A specific type of guidance that provides
an example of a completed work product.</li>
</ul>
See also:</div>
</div>
<div><div class="reltasks"><strong>Related tasks</strong><br />
<div><a href="createguidance.html#createguidance">Create Guidance</a></div>
</div>
</div>
</body>
</html>