blob: f16764263b64a765ec056b67df808c6e5d6429d2 [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" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<meta name="copyright" content="(C) Copyright 2005"/>
<meta name="DC.rights.owner" content="(C) Copyright 2005"/>
<meta name="DC.Type" content="concept"/>
<meta name="DC.Title" content="Documentation Team Responsibilities"/>
<meta name="abstract" content="A documentation team has several responsibilities when delivering context-sensitive help content."/>
<meta name="description" content="A documentation team has several responsibilities when delivering context-sensitive help content."/>
<meta name="DC.Relation" scheme="URI" content="../../../../../projects/dtp/dtp/en/source/c_team_responsibilities_and_collaboration.html"/>
<meta name="DC.Creator" content="dresch"/>
<meta name="DC.Format" content="XHTML"/>
<meta name="DC.Identifier" content="concept_9167A4694E7E43AB9D32835CBDAB0EE0"/>
<meta name="DC.Language" content="en"/>
<link rel="stylesheet" type="text/css" href="../../../../../styles/commonltr.css"/>
<link rel="stylesheet" type="text/css" href="../../../../../styles/doc.css"/>
<title>Documentation Team Responsibilities</title>
<meta name="provider" content="Sybase, Inc."/></head>
<body id="concept_9167A4694E7E43AB9D32835CBDAB0EE0"><a name="concept_9167A4694E7E43AB9D32835CBDAB0EE0"><!-- --></a>
<br/>
<h1 class="topictitle1">Documentation Team Responsibilities</h1>
<div><p>A documentation team has several responsibilities when delivering context-sensitive help content.</p>
<div class="p">Its primarily responsible to:
<br/><a name="concept_9167A4694E7E43AB9D32835CBDAB0EE0__ul_DCFCE572127243DE81A734DF3DF49F76"><!-- --></a><ul id="concept_9167A4694E7E43AB9D32835CBDAB0EE0__ul_DCFCE572127243DE81A734DF3DF49F76">
<li id="concept_9167A4694E7E43AB9D32835CBDAB0EE0__li_51378EFA35F94C60A80729F30378A81C"><a name="concept_9167A4694E7E43AB9D32835CBDAB0EE0__li_51378EFA35F94C60A80729F30378A81C"><!-- --></a>Develop context-specific help content and context-specific help search
expressions for appropriate UI help contexts.</li>
<li id="concept_9167A4694E7E43AB9D32835CBDAB0EE0__li_DE806556D8084035804E634F7DC8DA63"><a name="concept_9167A4694E7E43AB9D32835CBDAB0EE0__li_DE806556D8084035804E634F7DC8DA63"><!-- --></a>Define the concrete help context ID strings that associate abstract help
contexts with context-specific help content.</li>
<li id="concept_9167A4694E7E43AB9D32835CBDAB0EE0__li_33B9307781BF449098A71A1A319B6FD3"><a name="concept_9167A4694E7E43AB9D32835CBDAB0EE0__li_33B9307781BF449098A71A1A319B6FD3"><!-- --></a>Create the Java properties files that define the mapping of abstract help
contexts to concrete help context IDs.</li>
<li id="concept_9167A4694E7E43AB9D32835CBDAB0EE0__li_9E03F70533474D82B6067001B8C05B0F"><a name="concept_9167A4694E7E43AB9D32835CBDAB0EE0__li_9E03F70533474D82B6067001B8C05B0F"><!-- --></a>Create the context-sensitive help UA plug-ins that contribute Eclipse context
XML files and the Java properties files.</li>
<li>Test the context-sensitive help UA plug-ins and online documentation plug-ins,
with UI components provided by Development teams.</li>
</ul>
</div>
<p>Documentation teams should rely on the Java source files (for the helpKey
constants interface classes) as the original and definitive sources of all
helpKey constant strings.
</p>
<p>Creating the Java properties files can be somewhat automated (that is, by
processing the Java source files with a simple Perl script).
</p>
<p>Most of the other artifacts required for a context-sensitive help UA plug-in can
be generated by XSL transformations of a DITA-XML map document.
</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="../../../../../projects/dtp/dtp/en/source/c_team_responsibilities_and_collaboration.html" title="Successful delivery of dynamic context-sensitive help requires a close coordination of UI components and UA components. It imposes responsibilities on both Development teams and Documentation teams, and it requires ongoing collaboration among those teams.">Team Responsibilities and Collaboration</a></div>
</div>
</div>
<div/>
</body>
</html>