Bug 175189 - General - Authoring Guidelines to include guideline on references
Summary: General - Authoring Guidelines to include guideline on references
Status: ASSIGNED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: EPF (show other bugs)
Version: unspecified   Edit
Hardware: PC Windows XP
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: epf.documentation-inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-02-22 15:39 EST by Chris Sibbald CLA
Modified: 2023-02-16 16:17 EST (History)
1 user (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Chris Sibbald CLA 2007-02-22 15:39:04 EST 
The Authoring guidelines should provide a guideline that encourages adding any elements that are referenced in the text of an element (ex. an in-line hyperlink to a method element in the Main description) to the Guidance tab so that it shows up in the "More Information" section of the published site.

Rationale:
This will simplify maintenance by making it easier to identify the impact of a change.  If all referenced elements are explicitly related to the element by association (vs. hyperlink) it is easier to do an impact assessment.  Without this, one is forced to do a text search to find referenced elements.
Comment 1 Jim Ruehlin CLA 2007-04-30 13:20:47 EDT 
Reassigning to version 1.1, and identifying this as a General bug for tracking purposes.