Writing plain instructions: how to write user manuals, online help, and other forms of user assistance that every user understands
Gespeichert in:
| 1. Verfasser: | |
|---|---|
| Format: | Buch |
| Sprache: | English |
| Veröffentlicht: |
Zirndorf
Indoition
2012
|
| Ausgabe: | 1. ed. |
| Schriftenreihe: | Technical documentation solutions series
|
| Schlagworte: | |
| Online-Zugang: | Inhaltsverzeichnis |
| Beschreibung: | Literaturangaben |
| Beschreibung: | 360 S. 23 cm |
| ISBN: | 9783943860085 |
Internformat
MARC
| LEADER | 00000nam a2200000 c 4500 | ||
|---|---|---|---|
| 001 | BV041631156 | ||
| 003 | DE-604 | ||
| 005 | 00000000000000.0 | ||
| 007 | t | ||
| 008 | 140206s2012 gw |||| 00||| eng d | ||
| 015 | |a 13,A01 |2 dnb | ||
| 016 | 7 | |a 1025453484 |2 DE-101 | |
| 020 | |a 9783943860085 |c kart. |9 978-3-943860-08-5 | ||
| 024 | 3 | |a 9783943860085 | |
| 035 | |a (OCoLC)823311250 | ||
| 035 | |a (DE-599)DNB1025453484 | ||
| 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 Writing plain instructions |b how to write user manuals, online help, and other forms of user assistance that every user understands |c Marc Achtelig |
| 250 | |a 1. ed. | ||
| 264 | 1 | |a Zirndorf |b Indoition |c 2012 | |
| 300 | |a 360 S. |c 23 cm | ||
| 336 | |b txt |2 rdacontent | ||
| 337 | |b n |2 rdamedia | ||
| 338 | |b nc |2 rdacarrier | ||
| 490 | 0 | |a Technical documentation solutions series | |
| 500 | |a Literaturangaben | ||
| 650 | 0 | 7 | |a Hilfesystem |0 (DE-588)4377467-2 |2 gnd |9 rswk-swf |
| 650 | 0 | 7 | |a Benutzerhandbuch |0 (DE-588)4246778-0 |2 gnd |9 rswk-swf |
| 689 | 0 | 0 | |a Benutzerhandbuch |0 (DE-588)4246778-0 |D s |
| 689 | 0 | 1 | |a Hilfesystem |0 (DE-588)4377467-2 |D s |
| 689 | 0 | |5 DE-604 | |
| 775 | 0 | 8 | |i Parallele Sprachausgabe |n englisch-deutsch |a Achtelig, Marc: Writing plain instructions |w (DE-604)BV041048185 |
| 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=027072054&sequence=000001&line_number=0001&func_code=DB_RECORDS&service_type=MEDIA |3 Inhaltsverzeichnis |
| 999 | |a oai:aleph.bib-bvb.de:BVB01-027072054 | ||
Datensatz im Suchindex
| _version_ | 1804151850084073472 |
|---|---|
| adam_text | IMAGE 1
CONTENTS
1 HOW T O USE THIS BOOK 1 1
2 WRITING 13
2.1 WRITING IN GENERAL 15
KEEP IT SIMPLE AND STUPID 16
ALWAYS START WITH THE MAIN POINT 19
TALK TO THE READER 2 1
BE SPECIFIC 23
BE CONCISE 26
BE CONSISTENT 29
BE PARALLEL 32
BE POSITIVE 35
USE THE PRESENT TENSE 38
USE THE ACTIVE VOICE 39
DON T MAKE JUDGMENTS 4 1
DON T SAY PLEASE 43
2.2 WRITING TOPICS 45
WRITING CONCEPT TOPICS 46
WRITING TASK TOPICS 47
WRITING REFERENCE TOPICS 49
2.3 WRITING SECTIONS 5 1
DON T MIX SUBJECTS 52
ADD LABELS (SUBHEADINGS) 54
WRITING PROCEDURES 56
WRITING LISTS 64
WRITING TABLES 68
WRITING WARNINGS 72
WRITING NOTES 76
WRITING TIPS 78
WRITING EXAMPLES 79
WRITING CROSS-REFERENCES AND LINKS 8 1
5
HTTP://D-NB.INFO/1025453484
IMAGE 2
2 . 4 WRITING SENTENCES 87
MAKE SHORT SENTENCES 88
PUT THE MAIN THING INTO THE MAIN CLAUSE 9 1
AVOID PARENTHESES AND NESTED SENTENCES 92
FEEL FREE T O START SENTENCES SIMPLY 94
FEEL FREE TO END SENTENCES SIMPLY 95
WATCH THE ORDER O F WORDS 96
WATCH THE POSITION OF MODIFIERS 99
FEEL FREE TO REPEAT A WORD 1 0 1
USE REDUNDANCIES PURPOSEFULLY 103
ADD SYNTACTIC CUES 104
BE CLEAR ABOUT WHAT YOU RE REFERRING TO 106
USE THEN WITH CARE 108
USE AND WITH CARE 109
DON T USE AND/OR 110
DON T USE (S) 112
2 . 5 WRITING WORDS 113
USE SHORT, COMMON WORDS 114
WATCH FOR ...ED 116
WATCH FOR THE ... OF AND FOR O F THE 117
WATCH FOR OPENING I T . . . AND THERE ... 118
AVOID ABBREVIATIONS AND ACRONYMS 119
USE TECHNICAL TERMS CAREFULLY 122
ALWAYS USE THE SAME TERMS 123
USE CONTRACTIONS 125
AVOID STRINGS OF NOUNS 128
AVOID STACKS OF MODIFIERS 129
AVOID UNNECESSARY QUALIFICATION 130
USE STRONG VERBS 132
AVOID GERUNDS THAT CONCEAL A DIRECT VERB 134
AVOID PHRASAL VERBS 135
AVOID IDIOMATIC EXPRESSIONS 136
AVOID BUZZWORDS 137
AVOID DEVELOPER JARGON 138
USE FAIR LANGUAGE 139
BLACKLIST: OVERBLOWN WORDS 1 4 1
6
IMAGE 3
BLACKLIST: FILLER WORDS 159
2.6 FAQ: SPELLING AND PUNCTUATION 1 6 1
APOSTROPHES 162
CAPITALIZATION OF HEADINGS 165
CAPITALIZATION O F PRODUCTS AND FEATURES 167
COLONS 168
COMMAS 170
DASHES 177
ELLIPSES 180
EXCLAMATION POINTS 182
HYPHENS 183
NUMBERS 188
QUOTATION MARKS 190
SEMICOLONS 195
2.7 FAQ: G R A M M A R AND WORD CHOICE 197
ACCURATE / PRECISE 198
ALLOW / ENABLE 199
ALPHABETICAL ORDER ,200
AMONG / BETWEEN 2 0 1
AMOUNT / NUMBER 202
AND / AS WELL AS / PLUS 203
ASSUME / PRESUME 204
BECAUSE / SINCE / AS 205
BIG / GREAT / LARGE / LITTLE / SMALL 206
CAN / MAY / MIGHT / MUST / SHOULD 207
CHECK / CONTROL 2 1 1
COMPARE TO / COMPARE WITH 212
COMPRISE / COMPOSE / CONSTITUTE 213
CONTENT / CONTENTS 214
CONTINUAL / CONTINUOUS 215
COST / PRICE / VALUE / WORTH 216
DATA / INFORMATION 217
DEFINITE / DEFINITIVE 218
DIFFERENT FROM / DIFFERENT THAN 219
DISCREET / DISCRETE 220
DISTINCT / DISTINCTIVE 2 2 1
7
IMAGE 4
DO / MAKE / PERFORM 222
EACH / EVERY 223
EFFECTIVE / EFFICIENT 224
FEWER / LESS 225
FIGURE / GRAPHIC / IMAGE / PICTURE 226
FURTHER / FARTHER 227
HEADER / HEADING 228
IF / WHEN / WHETHER / WHETHER OR NOT 229
IF / IN CASE 2 3 1
IF-CLAUSES 232
IN / IN TO / INTO 234
IN / WITHIN 235
INDEX / INDEXES / INDICES 236
IT S NOT / IT ISN T 237
L A Y / L I E / L I E 238
LESS THAN / FEWER THAN / UNDER / BELOW 239
L E T / L E A V E 240
LIKE / SUCH AS / AS 2 4 1
LIKE / AS IF / AS THOUGH 242
MORE THAN / OVER / ABOVE 243
MANY / MUCH / A LOT OF / LOTS OF 244
MANY / VARIOUS / DIFFERENT 245
ON / UPON 246
POSSESSIVES 247
PRIOR / PREVIOUS 248
REGULAR / STANDARD / DEFAULT / PRESET 249
SAFETY / SECURITY 250
SINGLE / SINGULAR 2 5 1
T H A T / W H I C H 252
THAT / WHO / WHOM 254
THIS / THAT / THESE / THOSE 255
USE / UTILIZE / EMPLOY 256
W H A T / W H I C H 257
WHILE / AS / WHEREAS / ALTHOUGH 258
WANT / WISH / DESIRE / NEED 259
2 . 8 FAQ: STANDARD T E R M S AND PHRASES 2 6 1
HARDWARE 263
SOFTWARE 265
8
IMAGE 5
VERSIONS, UPDATES 268
SETUP 2 7 1
START, STOP 273
ASSISTANTS, DOCUMENTATION 276
WINDOWS, MESSAGES 278
CONTROLS: GENERAL RULES 282
CONTROLS: MENUS, RIBBONS, TOOLBARS 285
CONTROLS: TABS, GROUPS 288
CONTROLS: BUTTONS, COMMAND LINKS 290
CONTROLS: CHECK BOXES, OPTIONS 292
CONTROLS: FIELDS, BOXES, SLIDERS 294
CONTROLS: LISTS 296
CONTROLS: TASKBAR, STATUS BARS 300
MOUSE, TOUCHSCREEN 302
SCROLLING, ZOOMING 306
RESIZING, ALIGNING F 308
DELETING, CUTTING, PASTING 309
KEYS 310
CHARACTERS 314
FONTS 316
PRINTING 317
DISKS, FILES 318
INTERNET 322
ERRORS 326
SIGNAL WORDS 328
3 REFERENCES 329
4 FEEDBACK 339
9
|
| 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 | BV041631156 |
| ctrlnum | (OCoLC)823311250 (DE-599)DNB1025453484 |
| 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>01737nam a2200445 c 4500</leader><controlfield tag="001">BV041631156</controlfield><controlfield tag="003">DE-604</controlfield><controlfield tag="005">00000000000000.0</controlfield><controlfield tag="007">t</controlfield><controlfield tag="008">140206s2012 gw |||| 00||| eng d</controlfield><datafield tag="015" ind1=" " ind2=" "><subfield code="a">13,A01</subfield><subfield code="2">dnb</subfield></datafield><datafield tag="016" ind1="7" ind2=" "><subfield code="a">1025453484</subfield><subfield code="2">DE-101</subfield></datafield><datafield tag="020" ind1=" " ind2=" "><subfield code="a">9783943860085</subfield><subfield code="c">kart.</subfield><subfield code="9">978-3-943860-08-5</subfield></datafield><datafield tag="024" ind1="3" ind2=" "><subfield code="a">9783943860085</subfield></datafield><datafield tag="035" ind1=" " ind2=" "><subfield code="a">(OCoLC)823311250</subfield></datafield><datafield tag="035" ind1=" " ind2=" "><subfield code="a">(DE-599)DNB1025453484</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">Writing plain instructions</subfield><subfield code="b">how to write user manuals, online help, and other forms of user assistance that every user understands</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">360 S.</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 solutions series</subfield></datafield><datafield tag="500" ind1=" " ind2=" "><subfield code="a">Literaturangaben</subfield></datafield><datafield tag="650" ind1="0" ind2="7"><subfield code="a">Hilfesystem</subfield><subfield code="0">(DE-588)4377467-2</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="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">Hilfesystem</subfield><subfield code="0">(DE-588)4377467-2</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">Parallele Sprachausgabe</subfield><subfield code="n">englisch-deutsch</subfield><subfield code="a">Achtelig, Marc: Writing plain instructions</subfield><subfield code="w">(DE-604)BV041048185</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=027072054&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-027072054</subfield></datafield></record></collection> |
| id | DE-604.BV041631156 |
| illustrated | Not Illustrated |
| indexdate | 2024-07-10T01:01:22Z |
| institution | BVB |
| isbn | 9783943860085 |
| language | English |
| oai_aleph_id | oai:aleph.bib-bvb.de:BVB01-027072054 |
| oclc_num | 823311250 |
| open_access_boolean | |
| owner | DE-12 DE-29 |
| owner_facet | DE-12 DE-29 |
| physical | 360 S. 23 cm |
| publishDate | 2012 |
| publishDateSearch | 2012 |
| publishDateSort | 2012 |
| publisher | Indoition |
| record_format | marc |
| series2 | Technical documentation solutions series |
| spelling | Achtelig, Marc Verfasser (DE-588)1026228689 aut Writing plain instructions how to write user manuals, online help, and other forms of user assistance that every user understands Marc Achtelig 1. ed. Zirndorf Indoition 2012 360 S. 23 cm txt rdacontent n rdamedia nc rdacarrier Technical documentation solutions series Literaturangaben Hilfesystem (DE-588)4377467-2 gnd rswk-swf Benutzerhandbuch (DE-588)4246778-0 gnd rswk-swf Benutzerhandbuch (DE-588)4246778-0 s Hilfesystem (DE-588)4377467-2 s DE-604 Parallele Sprachausgabe englisch-deutsch Achtelig, Marc: Writing plain instructions (DE-604)BV041048185 DNB Datenaustausch application/pdf http://bvbr.bib-bvb.de:8991/F?func=service&doc_library=BVB01&local_base=BVB01&doc_number=027072054&sequence=000001&line_number=0001&func_code=DB_RECORDS&service_type=MEDIA Inhaltsverzeichnis |
| spellingShingle | Achtelig, Marc Writing plain instructions how to write user manuals, online help, and other forms of user assistance that every user understands Hilfesystem (DE-588)4377467-2 gnd Benutzerhandbuch (DE-588)4246778-0 gnd |
| subject_GND | (DE-588)4377467-2 (DE-588)4246778-0 |
| title | Writing plain instructions how to write user manuals, online help, and other forms of user assistance that every user understands |
| title_auth | Writing plain instructions how to write user manuals, online help, and other forms of user assistance that every user understands |
| title_exact_search | Writing plain instructions how to write user manuals, online help, and other forms of user assistance that every user understands |
| title_full | Writing plain instructions how to write user manuals, online help, and other forms of user assistance that every user understands Marc Achtelig |
| title_fullStr | Writing plain instructions how to write user manuals, online help, and other forms of user assistance that every user understands Marc Achtelig |
| title_full_unstemmed | Writing plain instructions how to write user manuals, online help, and other forms of user assistance that every user understands Marc Achtelig |
| title_short | Writing plain instructions |
| title_sort | writing plain instructions how to write user manuals online help and other forms of user assistance that every user understands |
| title_sub | how to write user manuals, online help, and other forms of user assistance that every user understands |
| topic | Hilfesystem (DE-588)4377467-2 gnd Benutzerhandbuch (DE-588)4246778-0 gnd |
| topic_facet | Hilfesystem Benutzerhandbuch |
| url | http://bvbr.bib-bvb.de:8991/F?func=service&doc_library=BVB01&local_base=BVB01&doc_number=027072054&sequence=000001&line_number=0001&func_code=DB_RECORDS&service_type=MEDIA |
| work_keys_str_mv | AT achteligmarc writingplaininstructionshowtowriteusermanualsonlinehelpandotherformsofuserassistancethateveryuserunderstands |