Archive:Docs Project Style Guide - Content and Rendering

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(Tried to improve the definition and follow the notes asked for by Patrick and Karsten.)
(3 intermediate revisions by 2 users not shown)
Line 5: Line 5:
 
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.
 
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.}}  
+
{{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 the 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.
Line 13: Line 13:
 
<!--  Nope.  That will go in a different section.  This section is meant to define the separation and not to teach a particular type of markup.  I might merge this page into another. -Patrick
 
<!--  Nope.  That will go in a different section.  This section is meant to define the separation and not to teach a particular type of markup.  I might merge this page into another. -Patrick
 
-->
 
-->
 +
 +
[[Category:Docs Project process]][[Category:Documentation]]

Revision as of 02:52, 26 February 2009

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.

Note.png
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 the new communication outlet. Therefore, separating markup language from subject matter content encourages use of the original content for future projects with little additional effort.