HOME

TheInfoList



OR:

Structured writing is a form of
technical writing Technical writing is writing or drafting technical communication used in technical and occupational fields, such as computer hardware and software, architecture, engineering, chemistry, aeronautics, robotics, finance, medical, consumer electronics, ...
that uses and creates
structured document A structured document is an electronic document where some method of markup is used to identify the whole and parts of the document as having various meanings beyond their formatting. For example, a structured document might identify a certain po ...
s. The term was coined by Robert E. Horn and became a central part of his information mapping method of analyzing, organizing, and displaying knowledge in print and in the new online presentation of text and graphics. Horn and colleagues identified dozens of common documentation types, then analyzed them into structural components called information blocks. They identified over 200 common block types. These were assembled into information types using information maps. The seven most common information types were concept, procedure, process, principle, fact, structure, and classification.


Some of the problems that structured writing addresses

Structured writing has been developed to address common problems in complex writing: * Organizing large amounts of material * Maintaining an orderly structure to provide a consistent experience to users * Providing users with a more intuitive and obvious experience * Ensuring the completeness of documentation * Targeting content to varying audiences * Coordinating writing projects among a group of writers * Organizing each chunk of content in an intuitive way * Organizing pages of content in a way that helps users understand its place in the whole body of knowledge * Maximizing the efficiency with which documentation can be understood and used


Relation to DITA

The seven most common information types identified by Horn and colleagues are loosely related to the three basic information types in
Darwin Information Typing Architecture The Darwin Information Typing Architecture (DITA) specification defines a set of document types for authoring and organizing topic-oriented information, as well as a set of mechanisms for combining, extending, and constraining document types. It i ...
(DITA): concept, task, and reference. An information mapping is a set of steps for a person. A is a set of steps for a system. Both resemble the DITA . DITA topics are assembled into documents using DITA maps.


See also

*
Component content management system A component content management system (CCMS) is a content management system that manages content at a granular level (component) rather than at the document level. Each component represents a single topic, concept or asset (for example an image, ...
*
Semantic markup Semantic HTML is the use of HTML markup to reinforce the semantics, or meaning, of the information in web pages and web applications rather than merely to define its presentation or look. Semantic HTML is processed by traditional web browsers a ...
* *
Topic-based authoring In technical communication, topic-based authoring is a modular approach to content creation where content is structured around topics that can be mixed and reused in different contexts. It is defined in contrast with ''book-oriented'' or ''narrati ...


References

* *


Notes

{{Reflist Technical communication