Archive:Docs Project Style Guide - Content and Rendering

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
m (added DocsProject header)
(Tried to improve the definition and follow the notes asked for by Patrick and Karsten.)
Line 3: Line 3:
 
== Content and Rendering ==
 
== Content and Rendering ==
  
When writing documentation to be displayed on assorted media or processed by different technologies, keep the written content and rendering information separate.  Many writers use formatting to distinguish between different types of information, such as bold text to add emphasis to important wordsWith modern technologies, however, writers can use specialized markup to identify important words. This markup allows the text to be rendered according to rules defined for the target medium or technology. Markup also allows information about that text to be retained even when special formatting is not available.
+
Writing documentation for display on assorted media through various technologies presents unique requirements.  In general, keep the written content and ''rendering information'' separate.  Rendering information is the formatting markup language to distinguish types of information, such as bold text to add emphasis.  Modern technologies empower writers to use specialized markup language to enhance communication. It is imperative writers participating in collaborative projects like the Fedora Documentation Project adhere to standards and prescribed templates.
 +
 
 +
{{admon\note|Benefits of Content and Markup Language Separation| Keeping content material and markup language separate from each other within documentation adds an additional benefit. As new media formats develop, project coordinators easily remove markup language and re-format the original content for a new communication outlet. Therefore, separating markup language from subject matter content encourages use of the original content for future projects with little additional effort.}}
  
 
<!--TODO: Need to further explain this and provide recommendations.
 
<!--TODO: Need to further explain this and provide recommendations.

Revision as of 19:49, 22 September 2008

DocsProject Header docTeam1.png


Content and Rendering

Writing documentation for display on assorted media through various technologies presents unique requirements. In general, keep the written content and rendering information separate. Rendering information is the formatting markup language to distinguish types of information, such as bold text to add emphasis. Modern technologies empower writers to use specialized markup language to enhance communication. It is imperative writers participating in collaborative projects like the Fedora Documentation Project adhere to standards and prescribed templates.

Template:Admon\note