all repos — h3rald @ v10

The sources of https://h3rald.com

contents/articles/33.html

 1
 2
 3
 4
 5
 6
 7
 8
 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
-----
title: "Information Mapping"
content-type: article
timestamp: 1149221400
tags: "productivity|writing"
-----
<p>As I thought, my job also represents a great opportunity to learn new things. I don't mean only new technical stuff,
	but also a great deal of tips, best practices and methods to efficiently write documentation material in proper
	English. Some theory about <a href="http://www.infomap.com/">Information Mapping</a> was by far the most interesting
	topic I learnt about this week.</p>
<h3>What is Information Mapping?</h3>
<p><strong>Definition<sup class="footnote" id="fnr1"><a href="#fn1">1</a></sup></strong> <br />
<blockquote>The Information Mapping method is a research-based approach to the analysis, organization, and visual
	presentation of information.</blockquote>
</p>
<p><strong>Information Mapping is media independent</strong><br />
<blockquote>The method is both subject matter and media independent; that is, it can be applied to the subject matter of
	any industry, and it can be presented on paper, on a computer screen, verbally, or in a multimedia presentation.
</blockquote>
</p>
<p><strong>Key Concepts</strong><br />
<blockquote>Information Mapping is an integrated set of easy-to-learn principles, techniques, and standards. It enables
	authors to break complex information into its most basic elements and then present those elements optimally for
	readers. The result is a set of precisely defined information modules that are consistent from author to author and
	document to document.</blockquote>
</p>
<p><strong>Purpose</strong><br />
<blockquote><br />
	The method helps writers analyze, organize, and present information with clarity focus and impact. Information That
	Works. The goal of the analysis component is to determine the</p>
	<ul>
		<li>purpose</li>
		<li>audience needs, and</li>
		<li>information types.</li>
	</ul>
	<p>The goal of the organization is to create an overall structure for the information, based on the results of your
		analysis. Finally, the goal of the presentation component is to format the information to make it clear and
		accessible to your audience.</p>
</blockquote>
<p class="footnote" id="fn1"><a href="#fnr1"><sup>1</sup></a> Contents were taken from <a
		href="http://www.infomap.com/index.cfm/TheMethod/">InfoMap.com</a> and were re-formatted and re-organized into
	an information map.</p>
<h3>Key Concepts</h3>
<p><strong>Introduction</strong><br />
<blockquote>The Information Mapping method relies on some important principles according to which information should be
	organized. This method also defines new units of information to replace paragraphs, sections and chapters and tries
	to divide information into a few main set types, each with its own rules and structures.</blockquote>
</p>
<p><strong>Principles</strong><br />
<blockquote>
	</p>
	<table>
		<tr>
			<td> <strong>Name</strong> </td>
			<td> <strong>Explanation</strong> </td>
		</tr>
		<tr>
			<td> Chuncking </td>
			<td> Writers should group information into small, manageable units. </td>
		</tr>
		<tr>
			<td> Relevance </td>
			<td> Writers should make sure that al information in a chunck relates to one main point (function or
				purpose). </td>
		</tr>
		<tr>
			<td> Labeling </td>
			<td> Writers should provide a label for every unit of information. </td>
		</tr>
		<tr>
			<td> Consistency </td>
			<td> Writers should use similar labels, word, formats for similar subject matters. </td>
		</tr>
		<tr>
			<td> Integrated Graphics </td>
			<td> The use of tables, images, diagrams and lists is encouraged. </td>
		</tr>
		<tr>
			<td> Accessible Detail </td>
			<td> Documents should provide sufficient details where necessary, to make the information more accessible
				for the readers. </td>
		</tr>
		<tr>
			<td> Hierarchy </td>
			<td> Small, relevant units of information should be organized into a hierarchy. </td>
		</tr>
	</table>
</blockquote>
<p><strong>Information Types</strong><br />
<blockquote>
	</p>
	<table>
		<tr>
			<td> <strong>Name</strong> </td>
			<td> <strong>Definition</strong> </td>
		</tr>
		<tr>
			<td> Procedure </td>
			<td> Set of steps to obtain a specified outcome </td>
		</tr>
		<tr>
			<td> Process </td>
			<td> A series of changes through the time for some purpose </td>
		</tr>
		<tr>
			<td> Structure </td>
			<td> Something which can be defined into multiple parts </td>
		</tr>
		<tr>
			<td> Concept </td>
			<td> Group of physical objects, conditions, relations, &#8230; </td>
		</tr>
		<tr>
			<td> Principle </td>
			<td> Statement of what should be done, assumptions </td>
		</tr>
		<tr>
			<td> Fact </td>
			<td> Statement presented with no supporting evidence </td>
		</tr>
		<tr>
			<td> Classification </td>
			<td> The sorting of a group of specimen into classes </td>
		</tr>
	</table>
</blockquote>
<p><strong>Conclusion</strong><br />
<blockquote>Although it may initially seem too schematic, Information Mapping is a valid method to organize and present
	information to those readers who just need &#8220;facts&#8221; without any unnecessary distraction. This method it
	is used with some modifications in many technical manuals and documentation written by many companies.</blockquote>
</p>