"How to write that f...ing manual": the essentials of technical writing in a nutshell
Gespeichert in:
| 1. Verfasser: | |
|---|---|
| Format: | Buch |
| Sprache: | English |
| Veröffentlicht: |
Zirndorf
Indoition
2012
|
| Ausgabe: | 1. ed. |
| Schriftenreihe: | Technical documentation basics
|
| Schlagworte: | |
| Online-Zugang: | Inhaltsverzeichnis |
| Beschreibung: | Literaturangaben |
| Beschreibung: | 201 S. Ill. 23 cm |
| ISBN: | 9783943860009 |
Internformat
MARC
| LEADER | 00000nam a2200000 c 4500 | ||
|---|---|---|---|
| 001 | BV041631180 | ||
| 003 | DE-604 | ||
| 005 | 00000000000000.0 | ||
| 007 | t | ||
| 008 | 140206s2012 gw a||| |||| 00||| eng d | ||
| 015 | |a 12,A49 |2 dnb | ||
| 016 | 7 | |a 1025453026 |2 DE-101 | |
| 020 | |a 9783943860009 |c kart. |9 978-3-943860-00-9 | ||
| 024 | 3 | |a 9783943860009 | |
| 035 | |a (OCoLC)820572862 | ||
| 035 | |a (DE-599)DNB1025453026 | ||
| 040 | |a DE-604 |b ger |e rakddb | ||
| 041 | 0 | |a eng | |
| 044 | |a gw |c XA-DE | ||
| 049 | |a DE-12 |a DE-29 | ||
| 082 | 0 | |a 808.066 |2 22/ger | |
| 084 | |a 800 |2 sdnb | ||
| 100 | 1 | |a Achtelig, Marc |e Verfasser |0 (DE-588)1026228689 |4 aut | |
| 245 | 1 | 0 | |a "How to write that f...ing manual" |b the essentials of technical writing in a nutshell |c Marc Achtelig |
| 250 | |a 1. ed. | ||
| 264 | 1 | |a Zirndorf |b Indoition |c 2012 | |
| 300 | |a 201 S. |b Ill. |c 23 cm | ||
| 336 | |b txt |2 rdacontent | ||
| 337 | |b n |2 rdamedia | ||
| 338 | |b nc |2 rdacarrier | ||
| 490 | 0 | |a Technical documentation basics | |
| 500 | |a Literaturangaben | ||
| 650 | 0 | 7 | |a Schreiben |0 (DE-588)4116418-0 |2 gnd |9 rswk-swf |
| 650 | 0 | 7 | |a Benutzerhandbuch |0 (DE-588)4246778-0 |2 gnd |9 rswk-swf |
| 650 | 0 | 7 | |a Textgestaltung |0 (DE-588)4259224-0 |2 gnd |9 rswk-swf |
| 689 | 0 | 0 | |a Benutzerhandbuch |0 (DE-588)4246778-0 |D s |
| 689 | 0 | 1 | |a Schreiben |0 (DE-588)4116418-0 |D s |
| 689 | 0 | 2 | |a Textgestaltung |0 (DE-588)4259224-0 |D s |
| 689 | 0 | |5 DE-604 | |
| 775 | 0 | 8 | |i Paralle Sprachausgabe |n deutsch |a Achtelig, Marc |t „How to write that f...ing manual“ |w (DE-604)BV041048200 |
| 856 | 4 | 2 | |m DNB Datenaustausch |q application/pdf |u http://bvbr.bib-bvb.de:8991/F?func=service&doc_library=BVB01&local_base=BVB01&doc_number=027072077&sequence=000001&line_number=0001&func_code=DB_RECORDS&service_type=MEDIA |3 Inhaltsverzeichnis |
| 999 | |a oai:aleph.bib-bvb.de:BVB01-027072077 | ||
Datensatz im Suchindex
| _version_ | 1804151850108190721 |
|---|---|
| adam_text | IMAGE 1
CONTENTS
1 HOW T O USE THIS BOOK 9
2 STRUCTURING 11
2.1 GENERAL STRUCTURING PRINCIPLES 13
MAKE IT GOAL-CENTERED 14
LAYER INFORMATION 20
SPLIT COMPLEX INFORMATION 26
2.2 WHICH TOPICS AND HEADINGS? 29
MAKE TOPICS SELF-CONTAINED 30
DISTINGUISH INFORMATION TYPES 32
FIND MEANINGFUL HEADINGS 35
TIPS FOR WRITING HEADINGS 38
2.3 WHICH O R D E R O F TOPICS? 41
KEEP THE STRUCTURE FLAT 42
PRIMARY STRUCTURE MODELS 44
3 DESIGNING 49
3.1 LAYOUT BASICS 5 1
USE CLEAR AND SIMPLE DESIGN 53
VISUALLY SUPPORT SKIMMING 55
ALIGN TEXTS AND OBJECTS TO A DESIGN GRID 56
AVOID AMATEURISH FORMATTING TECHNIQUES 58
AUTOMATE LINE BREAKS AND PAGE BREAKS 62
CREATE STYLES SEMANTICALLY 67
CREATE STYLES HIERARCHICALLY 7 1
3.2 CHOOSING FONTS AND SPACING 73
WHICH FONT? 74
WHICH FONT STYLE? 79
5
HTTP://D-NB.INFO/1025453026
IMAGE 2
WHICH FONT SIZE AND FONT SPACING? 8 1
WHAT LINE LENGTH? 83
4 WRITING 85
4 . 1 WRITING IN GENERAL 87
KEEP IT SIMPLE AND STUPID 88
ALWAYS START WITH THE MAIN POINT 90
TALK TO THE READER 9 1
BE SPECIFIC 93
BE CONCISE 96
BE CONSISTENT 98
BE PARALLEL 100
USE THE PRESENT TENSE 103
USE THE ACTIVE VOICE 104
DON T SAY PLEASE 106
4 . 2 WRITING SECTIONS 107
DON T MIX SUBJECTS 108
ADD LABELS (SUBHEADINGS) 110
WRITING PROCEDURES 112
WRITING LISTS 120
WRITING WARNINGS 124
WRITING CROSS-REFERENCES AND LINKS 128
4 . 3 WRITING SENTENCES 133
MAKE SHORT SENTENCES 134
PUT THE MAIN THING INTO THE MAIN CLAUSE 137
AVOID PARENTHESES AND NESTED SENTENCES 138
FEEL FREE TO REPEAT A WORD 140
ADD SYNTACTIC CUES 142
BE CLEAR ABOUT WHAT YOU RE REFERRING TO 144
DON T USE AND/OR 145
4 . 4 WRITING WORDS 147
USE SHORT, COMMON WORDS 148
WATCH FOR ...ED 149
WATCH FOR THE ... OF AND FOR O F THE 150
ANKK 6
IMAGE 3
WATCH FOR OPENING I T . . . AND THERE ... 1 5 1
AVOID ABBREVIATIONS AND ACRONYMS 152
USE TECHNICAL TERMS CAREFULLY 155
ALWAYS USE THE SAME TERMS 156
AVOID STRINGS OF NOUNS 158
AVOID STACKS OF MODIFIERS 159
AVOID UNNECESSARY QUALIFICATION 160
USE STRONG VERBS 1 6 1
USE FAIR LANGUAGE 163
4 . 5 FAQ: G R A M M A R AND WORD CHOICE 165
ACCURATE / PRECISE 166
ALLOW / ENABLE 167
AND / AS WELL AS / PLUS 168
BECAUSE / SINCE / AS 169
CAN / MAY / MIGHT / MUST / SHOULD 170
CHECK / CONTROL 174
EFFECTIVE / EFFICIENT 175
IF / WHEN / WHETHER / WHETHER OR NOT 176
LIKE / SUCH AS / AS 177
SAFETY / SECURITY 178
T H A T / W H I C H 179
USE / UTILIZE / EMPLOY 180
5 REFERENCES 181
6 FEEDBACK 1 9 1
MS MMM 7
|
| any_adam_object | 1 |
| author | Achtelig, Marc |
| author_GND | (DE-588)1026228689 |
| author_facet | Achtelig, Marc |
| author_role | aut |
| author_sort | Achtelig, Marc |
| author_variant | m a ma |
| building | Verbundindex |
| bvnumber | BV041631180 |
| ctrlnum | (OCoLC)820572862 (DE-599)DNB1025453026 |
| dewey-full | 808.066 |
| dewey-hundreds | 800 - Literature (Belles-lettres) and rhetoric |
| dewey-ones | 808 - Rhetoric & collections of literature |
| dewey-raw | 808.066 |
| dewey-search | 808.066 |
| dewey-sort | 3808.066 |
| dewey-tens | 800 - Literature (Belles-lettres) and rhetoric |
| discipline | Literaturwissenschaft |
| edition | 1. ed. |
| format | Book |
| fullrecord | <?xml version="1.0" encoding="UTF-8"?><collection xmlns="http://www.loc.gov/MARC21/slim"><record><leader>01813nam a2200469 c 4500</leader><controlfield tag="001">BV041631180</controlfield><controlfield tag="003">DE-604</controlfield><controlfield tag="005">00000000000000.0</controlfield><controlfield tag="007">t</controlfield><controlfield tag="008">140206s2012 gw a||| |||| 00||| eng d</controlfield><datafield tag="015" ind1=" " ind2=" "><subfield code="a">12,A49</subfield><subfield code="2">dnb</subfield></datafield><datafield tag="016" ind1="7" ind2=" "><subfield code="a">1025453026</subfield><subfield code="2">DE-101</subfield></datafield><datafield tag="020" ind1=" " ind2=" "><subfield code="a">9783943860009</subfield><subfield code="c">kart.</subfield><subfield code="9">978-3-943860-00-9</subfield></datafield><datafield tag="024" ind1="3" ind2=" "><subfield code="a">9783943860009</subfield></datafield><datafield tag="035" ind1=" " ind2=" "><subfield code="a">(OCoLC)820572862</subfield></datafield><datafield tag="035" ind1=" " ind2=" "><subfield code="a">(DE-599)DNB1025453026</subfield></datafield><datafield tag="040" ind1=" " ind2=" "><subfield code="a">DE-604</subfield><subfield code="b">ger</subfield><subfield code="e">rakddb</subfield></datafield><datafield tag="041" ind1="0" ind2=" "><subfield code="a">eng</subfield></datafield><datafield tag="044" ind1=" " ind2=" "><subfield code="a">gw</subfield><subfield code="c">XA-DE</subfield></datafield><datafield tag="049" ind1=" " ind2=" "><subfield code="a">DE-12</subfield><subfield code="a">DE-29</subfield></datafield><datafield tag="082" ind1="0" ind2=" "><subfield code="a">808.066</subfield><subfield code="2">22/ger</subfield></datafield><datafield tag="084" ind1=" " ind2=" "><subfield code="a">800</subfield><subfield code="2">sdnb</subfield></datafield><datafield tag="100" ind1="1" ind2=" "><subfield code="a">Achtelig, Marc</subfield><subfield code="e">Verfasser</subfield><subfield code="0">(DE-588)1026228689</subfield><subfield code="4">aut</subfield></datafield><datafield tag="245" ind1="1" ind2="0"><subfield code="a">"How to write that f...ing manual"</subfield><subfield code="b">the essentials of technical writing in a nutshell</subfield><subfield code="c">Marc Achtelig</subfield></datafield><datafield tag="250" ind1=" " ind2=" "><subfield code="a">1. ed.</subfield></datafield><datafield tag="264" ind1=" " ind2="1"><subfield code="a">Zirndorf</subfield><subfield code="b">Indoition</subfield><subfield code="c">2012</subfield></datafield><datafield tag="300" ind1=" " ind2=" "><subfield code="a">201 S.</subfield><subfield code="b">Ill.</subfield><subfield code="c">23 cm</subfield></datafield><datafield tag="336" ind1=" " ind2=" "><subfield code="b">txt</subfield><subfield code="2">rdacontent</subfield></datafield><datafield tag="337" ind1=" " ind2=" "><subfield code="b">n</subfield><subfield code="2">rdamedia</subfield></datafield><datafield tag="338" ind1=" " ind2=" "><subfield code="b">nc</subfield><subfield code="2">rdacarrier</subfield></datafield><datafield tag="490" ind1="0" ind2=" "><subfield code="a">Technical documentation basics</subfield></datafield><datafield tag="500" ind1=" " ind2=" "><subfield code="a">Literaturangaben</subfield></datafield><datafield tag="650" ind1="0" ind2="7"><subfield code="a">Schreiben</subfield><subfield code="0">(DE-588)4116418-0</subfield><subfield code="2">gnd</subfield><subfield code="9">rswk-swf</subfield></datafield><datafield tag="650" ind1="0" ind2="7"><subfield code="a">Benutzerhandbuch</subfield><subfield code="0">(DE-588)4246778-0</subfield><subfield code="2">gnd</subfield><subfield code="9">rswk-swf</subfield></datafield><datafield tag="650" ind1="0" ind2="7"><subfield code="a">Textgestaltung</subfield><subfield code="0">(DE-588)4259224-0</subfield><subfield code="2">gnd</subfield><subfield code="9">rswk-swf</subfield></datafield><datafield tag="689" ind1="0" ind2="0"><subfield code="a">Benutzerhandbuch</subfield><subfield code="0">(DE-588)4246778-0</subfield><subfield code="D">s</subfield></datafield><datafield tag="689" ind1="0" ind2="1"><subfield code="a">Schreiben</subfield><subfield code="0">(DE-588)4116418-0</subfield><subfield code="D">s</subfield></datafield><datafield tag="689" ind1="0" ind2="2"><subfield code="a">Textgestaltung</subfield><subfield code="0">(DE-588)4259224-0</subfield><subfield code="D">s</subfield></datafield><datafield tag="689" ind1="0" ind2=" "><subfield code="5">DE-604</subfield></datafield><datafield tag="775" ind1="0" ind2="8"><subfield code="i">Paralle Sprachausgabe</subfield><subfield code="n">deutsch</subfield><subfield code="a">Achtelig, Marc</subfield><subfield code="t">&#x201e;How to write that f...ing manual&#x201c;</subfield><subfield code="w">(DE-604)BV041048200</subfield></datafield><datafield tag="856" ind1="4" ind2="2"><subfield code="m">DNB Datenaustausch</subfield><subfield code="q">application/pdf</subfield><subfield code="u">http://bvbr.bib-bvb.de:8991/F?func=service&doc_library=BVB01&local_base=BVB01&doc_number=027072077&sequence=000001&line_number=0001&func_code=DB_RECORDS&service_type=MEDIA</subfield><subfield code="3">Inhaltsverzeichnis</subfield></datafield><datafield tag="999" ind1=" " ind2=" "><subfield code="a">oai:aleph.bib-bvb.de:BVB01-027072077</subfield></datafield></record></collection> |
| id | DE-604.BV041631180 |
| illustrated | Illustrated |
| indexdate | 2024-07-10T01:01:22Z |
| institution | BVB |
| isbn | 9783943860009 |
| language | English |
| oai_aleph_id | oai:aleph.bib-bvb.de:BVB01-027072077 |
| oclc_num | 820572862 |
| open_access_boolean | |
| owner | DE-12 DE-29 |
| owner_facet | DE-12 DE-29 |
| physical | 201 S. Ill. 23 cm |
| publishDate | 2012 |
| publishDateSearch | 2012 |
| publishDateSort | 2012 |
| publisher | Indoition |
| record_format | marc |
| series2 | Technical documentation basics |
| spelling | Achtelig, Marc Verfasser (DE-588)1026228689 aut "How to write that f...ing manual" the essentials of technical writing in a nutshell Marc Achtelig 1. ed. Zirndorf Indoition 2012 201 S. Ill. 23 cm txt rdacontent n rdamedia nc rdacarrier Technical documentation basics Literaturangaben Schreiben (DE-588)4116418-0 gnd rswk-swf Benutzerhandbuch (DE-588)4246778-0 gnd rswk-swf Textgestaltung (DE-588)4259224-0 gnd rswk-swf Benutzerhandbuch (DE-588)4246778-0 s Schreiben (DE-588)4116418-0 s Textgestaltung (DE-588)4259224-0 s DE-604 Paralle Sprachausgabe deutsch Achtelig, Marc „How to write that f...ing manual“ (DE-604)BV041048200 DNB Datenaustausch application/pdf http://bvbr.bib-bvb.de:8991/F?func=service&doc_library=BVB01&local_base=BVB01&doc_number=027072077&sequence=000001&line_number=0001&func_code=DB_RECORDS&service_type=MEDIA Inhaltsverzeichnis |
| spellingShingle | Achtelig, Marc "How to write that f...ing manual" the essentials of technical writing in a nutshell Schreiben (DE-588)4116418-0 gnd Benutzerhandbuch (DE-588)4246778-0 gnd Textgestaltung (DE-588)4259224-0 gnd |
| subject_GND | (DE-588)4116418-0 (DE-588)4246778-0 (DE-588)4259224-0 |
| title | "How to write that f...ing manual" the essentials of technical writing in a nutshell |
| title_auth | "How to write that f...ing manual" the essentials of technical writing in a nutshell |
| title_exact_search | "How to write that f...ing manual" the essentials of technical writing in a nutshell |
| title_full | "How to write that f...ing manual" the essentials of technical writing in a nutshell Marc Achtelig |
| title_fullStr | "How to write that f...ing manual" the essentials of technical writing in a nutshell Marc Achtelig |
| title_full_unstemmed | "How to write that f...ing manual" the essentials of technical writing in a nutshell Marc Achtelig |
| title_short | "How to write that f...ing manual" |
| title_sort | how to write that f ing manual the essentials of technical writing in a nutshell |
| title_sub | the essentials of technical writing in a nutshell |
| topic | Schreiben (DE-588)4116418-0 gnd Benutzerhandbuch (DE-588)4246778-0 gnd Textgestaltung (DE-588)4259224-0 gnd |
| topic_facet | Schreiben Benutzerhandbuch Textgestaltung |
| url | http://bvbr.bib-bvb.de:8991/F?func=service&doc_library=BVB01&local_base=BVB01&doc_number=027072077&sequence=000001&line_number=0001&func_code=DB_RECORDS&service_type=MEDIA |
| work_keys_str_mv | AT achteligmarc howtowritethatfingmanualtheessentialsoftechnicalwritinginanutshell |