Prosím, kliknite sem pre pomoc David McMurrey platba za webhosting:
Darujte akúkoľvek malú sumu, ktorú môžete.
Online technické písanie zostane zadarmo.
Táto stránka je momentálne v opravách.
A užívateľská príručka je technická dokumentácia, ktorá vysvetľuje, ako vykonávať bežné úlohy používateľa produktu. Bežné úlohy sú to akcie, ktoré musí byť používateľ schopný vykonať. The užívateľ je na úrovni znalostí a skúseností, ktorú produkt zamýšľa. Niektoré produkty majú základných používateľov a pokročilých používateľov—návod na použitie môže splniť jednu z týchto potrieb alebo obe. Premýšľajte o mikrovlnnej rúre: môže mať základného používateľa, a to je asi všetko. Na druhej strane, produkt grafického dizajnu môže mať základných aj pokročilých používateľov.
Informatívna grafika generovaná NotebookLLM v tejto kapitole
V tejto kapitole, dizajn knihy znamená obsah, štýl, formát, dizajn a poradie rôznych typických komponentov knihy. "Komponenty" tu odkazujú na skutočné sekcie alebo stránky knihy, ako sú oznámenie o vydaní, predslov, index alebo predná či zadná obálka. V kapitola dizajn stránky, termín element odkazuje na veci, ktoré sa môžu v knihe vyskytovať viackrát prakticky kdekoľvek, ako napríklad nadpisy, päty, tabuľky, ilustrácie, zoznamy, oznámenia, zvýraznenie a podobne.
Nasledujúce poskytuje prehľad typických komponentov tlačenej technickej knihy a typického obsahu, formátu, štýlu a sekvencie týchto komponentov. Určite žiadny jednotlivý používateľský sprievodca, technický referenčný manuál, dokument rýchlej referencie alebo iný takýto dokument by skutočne nemal všetky tieto komponenty navrhnuté a usporiadané presne tak, ako práve čítate. Namiesto toho tento prehľad poskytne prehľad možností—povedzme rozsah možností.
Poznámka: V súčasnosti máme iba príklad návod na použitie vyvinuté v FrameMaker a potom exportované do PDF. Chýba mu slovník, ale všetky ostatné časti typického používateľského sprievodcu sú na svojom mieste. (Neviem prísť na to "d" v "Filepad"!) Majte na pamäti, že nepoužíva niektoré požiadavky na písmo a okraje uvedené nižšie.
Predtým, ako začnete čítať nasledujúce, vezmite si niekoľko kníh o hardvéri a softvéri, aby ste mohli porovnať ich obsah, štýl, formát a usporiadanie s tým, čo je tu prediskutované.
Pre ešte podrobnejšie informácie, ako vidíte tu, sa obráťte na tieto dve štandardné priemyselné zdroje:
- Sun technické publikácie. Prečítajte si ma najprv! Akékoľvek nedávne vydanie. Prentice Hall.
- Microsoft Corporation. Microsoft príručka štýlu pre technické publikácie. Akékoľvek nedávne vydanie. Microsoft Press.
Môžete si pozrieť príklady týchto knižných komponentov v Techdoc dizajn.
Predná a zadná obálka
Dokumenty produktov pre platících zákazníkov zvyčajne majú pekne navrhnuté predné strany, aj keď vo vnútri môže byť kniha na úrovni nízkej kvality. Na prednej strane obálky zvyčajne uvidíte niektoré alebo všetky z nasledujúcich prvkov:
- Názov spoločnosti
- Názov produktu
- Produktová platforma alebo operačný systém
- Čísla verzie produktu a vydania
- Názov knihy
- Logá spoločností alebo produktov
- Ochranne známky
- Umelecké dielo
- Číslo objednávky knihy
- Slogan spoločnosti alebo produktu
Môže byť náročné nájsť dobrý formát pre názov spoločnosti, názov produktu a názov knihy. Niekedy sa to môže zmeniť na celý odsek textu! Spoločnosti sú dosť rozdelené, pokiaľ ide o to, či uviesť verziu a čísla vydania na predných obaloch—niektoré to robia; niektoré nie. Takmer vždy však uvidíte, že je uvedená platforma—či je produkt pre Macintosh, PC, UNIX a podobne.
Príklad titulnej strany.
Zadný obal tlačených používateľských príručiek a manuálov je zvyčajne veľmi jednoduchý. Zvyčajne obsahuje číslo objednávky knihy, názov spoločnosti s príslušnými ochrannými známkami, symbol autorského práva a formuláciu týkajúcu sa vlastníctva knihy, ako aj vyjadrenie o tom, v ktorej krajine bola kniha vytlačená. Na zadnom obale nájdete aj čiarové kódy. Skontrolujte, či váš softvér dokáže vygenerovať čiarový kód —, stačí pristúpiť k utilite čiarového kódu, zadať číslo objednávky knihy a utilita vygeneruje čiarový kód.
Titulná strana
Titulná strana je zvyčajne kópiou prednej obálky, ale s určitými prvkami vynechanými. Zvyčajne sú vynechané umenie, logá spoločnosti alebo produktu a slogany. Niektoré technické publikácie úplne vynechávajú titulnú stranu kvôli zjavne zbytočnej duplicitnej. (A pri tlači 20 000 výtlačkov znamená jedna stránka veľa!)
Príklad titulnej strany.
Upozornenie na edíciu
Oznámenie o vydaní je zvyčajne prvým výskytom bežného textu v technickej publikácii, hoci je zvyčajne v menšom písmene. Nachádza sa na zadnej strane titulnej stránky. Ak technický vydavateľ uplatňuje prístup lean-and-green a odstraňuje titulnú stránku, oznámenie o vydaní sa objaví na zadnej strane prednej obálky.
Nikto nemá rád čítanie drobného písma, ale pozrite sa na vyhlásenia, ktoré sú zvyčajne zahrnuté v oznámení o vydaní:
Príklad výzvy na odstránenie vady
Ochranné známky
Či zahrniete ochranné známky a ako ich uvádzate, je vecou právnikov spoločnosti. V každom prípade uvádzajte iba tie názvy produktov chránené ochranou známkou, ktoré sa nachádzajú v danom užívateľskom návode.
Najčastejšie sú ochranné známky označené:
- v oznámení o vydaní (ako ukazuje vyššie uvedená ilustrácia)
- v samostatnej sekcii niekde v používateľskej príručke
spomeňte si na tú poznámku
Ak firemní právnici chcú, aby bolo každé objavenie sa názvu chráneného výrobku označené hviezdičkou alebo poznámkou pod čiarou, snažte sa ich od tohto stránkového dizajnu odradiť. Rozhadzovanie textu hviezdičkami alebo číslami poznámok pod čiarou rozptyľuje čitateľov.
Záruky
Záruky sprevádzajú fyzické hardvérové produkty—nie softvér. Firemní právnici zodpovedajú za jazyk a formát záruky. Ak vytvárate príklad používateľskej príručky alebo knihy pre svoje portfólio, môžete použiť tento anonymný "príklad záruky".vyskakovacie okno aby ste ukázali, že ste si vedomí, že záruky musia byť zahrnuté.
softvérové záruky?Bezpečnostné oznámenia
Hardvérové produkty zvyčajne majú sekciu bezpečnostných oznámení na začiatku svojich kníh. Tieto môžu byť umiestnené ako podsekcia predhovoru, napríklad, alebo ako samostatná sekcia vo svojom vlastnom práve. Tieto sekcie zvyčajne zhromažďujú všetky oznámenia o nebezpečenstve, varovania a opatrnosti, ktoré sa vyskytujú v celej knihe a usporiadavajú ich nejakým logickým spôsobom. Ale aj s týmto upozornením na začiatku, hardvérové knihy stále umiestňujú jednotlivé oznámenia na miesta, kde sa uplatňujú. (Pre viac informácií, pozri špeciálne oznámenia.)
Komunikačné vyhlásenia
Knihy o hardvéri si tiež vyžadujú vyhlásenia o komunikácii, ako to stanovujú vlády krajín, do ktorých sú tieto produkty zasielané. V USA FCC vyžaduje určité vyhlásenia o komunikácii v závislosti od "triedy" hardvérového produktu. Ako autor si musíte dávať pozor na to, aby ste použili správne vyhlásenie o komunikácii pre produkt, ktorý dokumentujete—a aby ste vyhlásenie nijako neupravovali (sväté právne slová!).
Obsah
Obsah (TOC) zvyčajne obsahuje aspoň druhú úroveň detailov (hlavy 1 v skutočnom texte), aby čitatelia mohli presnejšie nájsť to, čo potrebujú. Písatelia, redaktori a dizajnéri kníh sa zvyčajne hádajú o poradí obsahu. Z hľadiska použiteľnosti je oveľa lepšie mať obsah čo najbližšie k začiatku knihy, ak nie na samotnom začiatku. Z právnych dôvodov sa však ľudia obávajú, že všetky tie vyhlásenia o komunikácii, záruky, autorské práva, ochranné známky a upozornenia na bezpečnosť by mali byť na prvom mieste. V tých prípadoch, kde vyhráva použiteľnosť, knihy používajú všetky taktiky, ktoré môžu, aby sa tento právnický materiál dostal z úvodu: záruky sú umiestnené na samostatných kartách a zabalené s knihou alebo produktom; záruky, vyhlásenia o komunikácii, ochranné známky a podobné veci môžu byť presunuté do príloh.
Problémy s vytváraním pekne formátovanej obsahu? Pozrite sa na Vytvorte profesionálne vyzerajúci obsah (TOC)
Zoznam obrázkov
Technické príručky pre bežných používateľov zvyčajne nemajú zoznamy obrázkov. V skutočnosti samotné obrázky zvyčajne nemajú úplné nadpisy. Ale to neznamená, že zoznam obrázkov nemá miesto v technických príručkách. Všetko závisí od čitateľa a jeho potrieb—a obsah knihy tiež. Ak kniha obsahuje tabuľky, ilustrácie, grafy, diagramy a iné veci, ktoré chcú čitatelia priamo nájsť, zoznam obrázkov je na mieste.
Predslov
Funkcia predhovoru je pripraviť čitateľov na čítanie knihy. To dosahuje tým, že:
- charakterizovanie obsahu a účelu knihy
- identifikácia alebo dokonca stručný popis produktu, ktorý kniha podporuje
- vysvetlenie typu čitateľa, pre ktorého je kniha určená
- naznačenie hlavných obsahov knihy
- zobrazenie akýchkoľvek špeciálnych konvencií alebo terminológie použitej v knihe
- poskytovanie podpory a marketingových čísel, a iné také
V tradičnom knižnom vydavateľstve príspevok predchádza obsahu; ale ako sme predtým diskutovali v obsah v sekcii technického vydávania chcú, aby sa obsahu knihy (TOC) dostalo skôr z dôvodov použiteľnosti.
Telo kapitol
Ó áno, a v týchto knihách je skutočný text—nie je to len úvod! Malú víziu povedať tu, len to, že väčšina technických kníh má kapitoly alebo sekcie a v niekoľkých prípadoch aj časti. Pozrite si kapitolu o dizajn stránky pre formát, štýl a dizajn otázky pre prvky ako sú hlavičky, päty, nadpisy, zoznamy, oznámenia, tabuľky, grafika, krížové odkazy a zvýraznenie.
Prílohy
Ako viete, prílohy sú na materiál, ktorý sa jednoducho nezdá byť vhodný do hlavnej časti knihy, ale nemôže byť z knihy vynechaný. Prílohy sú často miestom pre veľké, ťažkopádne tabuľky. Niektoré technické publikácie obsahujú veci ako záruky v prílohách. Pokiaľ ide o formát, príloha je rovnaká ako kapitola, akurát je označená "Príloha A" alebo niečo podobné a hlavičky a päty zodpovedajú tomuto inému číslovaniu a názvovému konvenčnému systému (A-1, A-2 a tak ďalej pre strany v Prílohe A).
Slovník
Niektoré technické publikácie obsahujú sekciu špecializovaných pojmov a ich definícií. Všimnite si, že väčšina glosárov používa dvojstĺpcové usporiadanie. Zvyčajne každý pojem a jeho definícia tvoria samostatný odsek, pričom pojem je napísaný malými písmenami (iba ak nejde o vlastné meno) a je tučný, za ním nasleduje bodka a potom definícia písaná obyčajným písmom. Všimnite si tiež, že definície zvyčajne nie sú úplné vety. Dobré definície v glosári by mali používať techniku formálnej definície, ako je opísané v. definičná kapitola tohto online tekstu. Viaceré definície sú zvyčajne uvedené arabskými číslami v zátvorkách. Odseky s glosárom obsahujú tiež Vidieť odkazy na preferované termíny a Pozri tiež odkazy na súvisiace termíny.
Index
Indexy sú zvyčajne tiež dvojstĺpcové a obsahujú aj Vidieť odkazy na preferované termíny a Pozri tiež odkazy na príbuzné výrazy. Pozrite sa na kapitolu o indexovanie pre procesy a pokyny na vytváranie kvalitných indexov.
Formulár na reakciu čitateľa
Pred vznikom internetu a sociálnych médií niektoré technické publikácie obsahovali hardvérovú formu, ktorá umožňovala čitateľom zasielať komentáre, otázky a hodnotenie knihy. Samozrejme, ukazuje sa, že tieto formuláre častejšie vyvolávajú sťažnosti na chybnú funkciu produktu, ktorý kniha dokumentuje. So vznikom internetu sa tieto formuláre dostali online a knihy len odkazujú na ich umiestnenie na internete.
Dizajn a rozloženie knihy
Typicky sú návody a príkazy, ktoré vyrábajú výrobcovia hardvéru a softvéru, navrhnuté dosť stroho a asketicky. Vysokotechologické spoločnosti vyvíjajú nové verzie a uvoľnenia svojich produktov niekedy každých deväť mesiacov. V tomto kontexte nie je sofistikovaný dizajn praktický. Tu sú niektoré typické prvky rozloženia a dizajnu, ktoré uvidíte:
- Veľkosť stránky je často určená požiadavkami na balenie, ako aj štandardnými veľkosťami strán dostupnými u tlačových spoločností. Keď nie je veľkosť stránky obmedzením, niektoré spoločnosti používajú veľkosť stránky 8,5 × 11-palcov— to uľahčuje výrobu pre autorov.
- Strany sú typicky navrhnuté s alternujúcimi pravými a ľavými stranami. Spodok pre ľavú (sudú) stranu začína číslom strany a končí názvom knihy. Spodok pre pravú (lichú) stranu začína názvom kapitoly a končí číslom strany.
- Praxe je zmiešaná, či má byť číslovanie strán po celú knihu jednotné alebo podľa kapitol.
- Pokiaľ nie sú stránky obzvlášť malé, dizajn nadpisov so zaveseným odsadením vo vzťahu k stranám je v technických manuáloch pomerne bežný. Zavesené odsadenie je zvyčajne jeden palec až jeden a pol palca.
- Písma sú často 12-bodový Times New Roman pre text tela a Arial pre nadpisy. Používajú sa štandardné riadkovanie a medzery medzi slovami. Pozrite sa na kapitolu o zvýrazňovanie pre ďalšie typografické problémy.
- Okraje sú pomerne štandardné, od jeden do dva palce po celom obvode. Zvyčajne sa na vnútorných okrajoch pridáva extra pol palca, aby sa umožnilo viazanie.
- Typicky, farba je nie používané v týchto manuáloch a príručkách, zvyčajne z dôvodov nákladov a efektívnosti.
Obsah
obsah
Akúkoľvek formu obsahu (TOC) použijete, tieto sú bežné štandardy:
- Začínajúce číslo strany iba. Aj keď niektoré automatické generátory obsahu zobrazujú rozsah stránok, štandardne je to iba číslo prvej stránky.
- Úrovne nadpisov na zahrnutie. Ako je uvedené v obsahu vyššie, zobrazte dve najvyššie úrovne nadpisov, pokiaľ používateľská príručka nemá mnoho podnadpisov. Obsah by mal poskytnúť rýchly prehľad na nájdenie informácií.
- Medzera a veľké písmená. Všimnite si, ako sú textové položky v obsahu vyššie odsadené. Názvy prvého stupňa sú písmom veľkými písmenami; názvy druhého stupňa používajú veľké iniciály na každé hlavné slovo; názvy tretieho stupňa používajú veľké písmeno na začiatku vety.
- Vertikálne odsadenie. Všimnite si, že sekcie prvej úrovne majú extra priestor nad a pod, čo zvyšuje čitateľnosť.
V závislosti od požiadaviek vašej organizácie máte na výber dva formáty pre obsah (TOC):
Tento obsah používa desatinný systém číslovania pre čísla kapitol a sekcií, čo je bežné v používateľských príručkách. Ostatné v tejto knihe používajú štýl veľkých rímskych číslic len pre najvyššie úrovne kapitol (pozri ).
Máte problémy s vytvorením pekne naformátovaného obsahu? Pozrite sa na Vytvorte profesionálne vyzerajúci obsah.
Čiarky a čísla strán. Ak formát s vodorovnou bodkou nie je potrebný a radšej sa mu vyhnete, môžete použiť tento bežne akceptovaný formát:
Pozrite si tento príklad predslovu:
Jednoduchý obsah s číslami strán a čiarkami.Zoznam obrázkov
Nie je často zahrnuté v užívateľských príručkách...
-->Predslov
Používateľská príručka Hlavné kapitoly
Prílohy
Index
Iné prvky používateľskej príručky
Nadpisy
Odrážkové a číslované zoznamy
Symboly, čísla a skratky
Grafika a názvy obrázkov
Krížové odkazy
Číslovanie strán
AI výzvy pre používateľské príručky
Kontrolné zoznamy, ktoré sa zvyčajne ignorujú, môžu byť po určitých úpravách použitý ako zdroj pre AI podnety. Skopírujte nasledujúce, vložte do AI systému, ako je napríklad Google's Gemini, a zistite, čo ste mohli premeškať.
Poznámka: Všetky odkazy na obsah, formát, štýl používateľských príručiek alebo ich komponentov nájdete v online učebnica technického písania.
Keď chcete použiť AI na hodnotenie písacieho projektu, predstavte sa, povedzte AI, kto ste a čo chcete. Dajte AI referenčný bod na vykonávanie hodnotení, ako je online učebnica. Potom zverejnite, čo chcete, aby AI skontrolovalo vo svojom hodnotení.
Upravte úvod tak, aby vyhovoval vašej identite.
|
AI podporné návody pre používateľov Ahoj, AI. Žiadam ťa, aby si ohodnotil pokyny napísané študentom druhého ročníka americkej vysokej školy. Nižšie je súhrn kapitol učebnice o pokyny a oznámenia použiť ako základ pre vaše hodnotenie. (Identifikačné informácie sú zahalené):
|
Súvisiace informácie
Ako písať používateľsky prívetivé témy pomoci pre začiatočníkov. clickhelp.com
Ako písať používateľskú dokumentáciu. techscribe
Používateľské príručky. techscribe
Bolo by mi cťou, keby ste sa podelili o svoje myšlienky, reakcie a kritiku na túto kapitolu: vaša odpoveď—David McMurrey.
