From Fedora Project Wiki
(Moved to guide) |
|||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Moved to guide}} | |||
{{header|docs}} | {{header|docs}} | ||
| Line 5: | Line 6: | ||
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 | {{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 14: | ||
<!-- 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]] | |||
Latest revision as of 14:38, 22 March 2014
Old page
The data in this page has been incorporated into a formal guide and is no longer being maintained.
The data in this page has been incorporated into a formal guide and is no longer being maintained.
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.
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.
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.