Dizajn stránky znamená pre rôznych ľudí rôzne veci, ale tu bude znamenať používanie typografie a formátovania, aké vidíte v profesionálne navrhnutých dokumentoch.
Naša pozornosť je zameraná na technickú dokumentáciu, čo predpokladá skromný, funkčný dizajn.
Pre ešte podrobnejšie informácie, ako vidíte tu, sa obráťte na tieto dva štandardné priemyselné zdroje:
- Sun technické publikácie. Prečítaj si ma najprv! Akékoľvek nedávne vydanie. Prentice Hall.
- Microsoft Corporation. Microsoft manuál štýlu pre technické publikácie. Akékoľvek nedávne vydanie. Microsoft Press.
Hlavičky a päty
Ľudia často zamieňajú hlavičky s nadpismi. Nadpisy, ktorým sa venuje nadpisy sú tieto frázy sa vyskytujúce v oblasti tela dokumentu. Hlavičky sú tie frázy a možno aj čísla strán, ktoré sa vyskytujú v oblasti hlavičky dokumentu. Päty sú tie frázy a možné čísla strán, ktoré sa vyskytujú v oblasti päty dokumentu. Bežná chyba, a to veľká, je umiestnenie názvu dokumentu do hlavičky, čo spôsobuje, že sa zobrazuje na vrchu každej nasledujúcej stránky.
Pozrite sa na diagram typickej stránky dokumentu:
Jedným bežným dizajnom strany je umiestniť názov dokumentu a číslo strany do dolnej časti stránky. V alternatívnom formáte môže ľavá strana zobrazovať číslo strany a názov dokumentu v tomto poradí; pravá strana môže zobrazovať názov dokumentu a číslo strany, v tomto poradí.
Nadpisy
Nasledujúce predstavuje niektoré z bežných pokynov týkajúcich sa nadpisov. Pre podrobnejšiu diskusiu pozrite kapitolu o nadpisy v online učebnici.
- Využite liberalne nadpisy, možno jeden nadpis na každé dva až tri odseky. Samozrejme, nadpisy môžu byť prehnané: veľa nadpisov s len jedným alebo dvoma vetami na nadpis nefunguje.
- Navrhnite nadpisy tak, aby jasne naznačovali svoju úroveň. Použite veľkosť písma, štýl písma, farbu, tučné písmo, kurzívu, zarovnanie tak, aby úroveň nadpisu bola zrejmá. ("Úrovne" nadpisov sú ako úrovne v osnovách: prvá úroveň by zodpovedala rímskym čísliciam; druhá úroveň, veľkým písmenám; a tak ďalej.)
- Urobte nadpisy popisné pre sekcie, ktoré uvádzajú. Nadpisy ako "Technické pozadie" nikomu nič nepovedia.
- Urobte nadpisy paralelný v formulácii. Paralelizmus poskytuje čitateľom dôležité náznaky, či je sekcia podobná predchádzajúcim.
- Vyhýbajte sa „osamelým nadpisom“—, je to ten istý koncept ako mať „A“ bez „B“ alebo „1“ bez „2“ v osnovách.
- Vyhnite sa "stohovaným nadpisom"—to znamená dva alebo viac po sebe idúcich nadpisov bez zasahujúceho textu.
- Vyhnite sa odkazovaniu na nadpisy pomocou zámen v texte nasledujúcom po nadpisoch. Ak máte nadpis ako „Konfigurácia softvéru“, nesledujte ho vetou ako „Toto ďalšie štádium...“
- Zvážte používanie formátu "zavesenej hlavy", aby ste zvýraznili nadpisy a znížili dĺžku riadkov bežného textu. V dizajne zavesenej hlavy sú niektoré alebo všetky nadpisy na ľavom okraji, zatiaľ čo všetok text je odsadený o jeden až dva palce.
- Zvážte použitie "bežných" nadpisov pre váš najnižší úroveň nadpisu. Môže byť ťažké spoliehať sa iba na štýl a veľkosť písma na určenie úrovní nadpisov. Bežný nadpis "vrhá" svoj text na začiatok odseku a končí bodkou. Môžete použiť kombináciu tučného písma, kurzívy alebo farieb pre tieto nadpisy.
Zoznamy
Zoznamy sú užitočné nástroje na zdôraznenie dôležitých bodov, umožňujú rýchle skenovanie textu a poskytujú viac prázdneho miesta. Nasledujúce uvádza niektoré z obyčajných usmernení pre zoznamy. Pre podrobnejšiu diskusiu si prečítajte kapitolou o zoznamy.
- Použite číslované zoznamy pre položky, ktoré musia byť v požadovanom poradí alebo ktoré sa musia uviesť podľa čísla. Použite odrážkové zoznamy pre položky, ktoré nie sú v požadovanom poradí.
- Použite štandardný číslovaný a odrážkový formát dostupný v odsekových štýloch spracovania textu, HTML značkách a iných.
- Upravte formuláciu položiek zoznamu. paralelný.
- Začnite všetky zoznamy úvodom; na úvod k zoznamom nepoužívajte nadpisy.
- Ak štýl vašej organizácie nepredpisuje inak, oddeľujte položky zoznamu bodkou iba vtedy, ak sú to kompletné vety alebo obsahujú vložené závislé vety.
- Použite buď veľké písmeno alebo malé písmeno na prvom slove položiek zoznamu, ale robte to konzistentne.
- Pre vnorené zoznamy použite tučnú en pomlčku ako symbol odrážky pre položky druhého stupňa zoznamu; použite malé písmená pre číslované položky druhého stupňa zoznamu. Uistite sa, že vnorené položky sú zarovnané na text alebo predchádzajúca úroveň.
- Vyhnite sa nadmernému používaniu zoznamov alebo zoznamov s príliš veľkým počtom položiek. Sedem až desať položiek sa považuje za maximálne prijateľný počet pre zoznamy.
Oznámenia
Oznámenia sú špeciálne formátované časti textu, ktoré upozorňujú čitateľov na špeciálne body, výnimky, potenciálne problémy alebo nebezpečenstvo. Nasledujúce uvádza niektoré z bežných usmernení pre oznámenia. Pre podrobnejšiu diskusiu pozrite kapitolu o oznámenia.
- Použite štandardnú hierarchiu oznámení, v ktorej sú oznámenia výraznejšie a viditeľnejšie, čím sú závažnejšie.
- Zvážte použitie tejto hierarchie:
- oznámenia o nebezpečenstve pre situácie, ktoré môžu viesť k vážnemu zraneniu alebo smrti
- varovania pre situácie súvisiace s menším zranením
- opatrnosti pre situácie zahŕňajúce poškodenie zariadenia alebo dát, alebo hrozbu úspechu postupu
- poznámky k výnimkám alebo zdôrazneniam, ktoré sa netýkajú predchádzajúcich situácií.
- Nezáleží na dizajne oznámenia, vyhýbajte sa dlhému textu písanému celým tučným písmom, celým kurzívou, veľkými písmenami alebo ich kombináciám.
- Okrem toho, že čitateľom poviete, čo robiť alebo čo nerobiť, vysvetlite, čo sa stane, ak varovanie ignorujú, za akých podmienok sa má dané vyhlásenie použiť, a ako sa zotaviť, ak sa vyhlásenie ignoruje.
- Urobte text oznámení stručným, ale nie na úkor jasného písania. Vyhnite sa telegramovému štýlu písania (vynechanie článkov ako). a, an, ten) v oznámeniach.
- Na číslovaných zoznamoch zarovnajte oznámenia na text zo zoznamu položiek, na ktoré sa vzťahujú.
- Štandardná múdrosť umiestňovania oznámení predtým Krok, v ktorom môže existovať potenciálny problém, môže spôsobiť problémy s formátovaním. Ak je to možné, uveďte varovania, upozornenia alebo nebezpečenstvá na začiatku celého postupu.
Čísla
Obrázky sú všetky možné ilustrácie, kresby, schémy, fotografie a podobne. Vidieť grafika na podrobnú diskusiu. Medzitým sú tu niektoré dôležité body:
- V texte pred obrázkom uveďte odkaz na obrázok.
- Aj keď nie je absolútne nevyhnutné pridať popis obrázku (názov) pre každý obrázok, ak to urobíte, umiestnite ho nižšie figúra.
- Napríklad v pokynoch, keď sú obrázky úzko späté s jednotlivými krokmi, názvy obrázkov nemajú zásadnú funkciu a nie sú potrebné.
Stoly
Tabuľky sú ako vertikálne zoznamy, o ktorých sme hovorili predtým, ale sú viac štruktúrované a formálne. V texte hľadajte opakujúce sa dvojice, trojice alebo štvorky položiek, ktoré je možné naformátovať ako tabuľky. Napríklad séria pojmov a definícií je klasickým príkladom pre tabuľky. Nasledujúce uvádza niektoré z bežných usmernení pre tabuľky. Pre podrobnejšiu diskusiu pozrite kapitolu o stoly.
- Hľadajte opakujúce sa skupiny položiek vo vašom texte, ktoré môžete formátovať ako tabuľky.
- V texte pred tabuľkou uveďte krížovú referenciu na tabuľku.
- Použite názov tabuľky, pokiaľ obsah tabuľky nie je úplne zrejmý a tabuľka obsahuje málo položiek. Umístite názov tabuľky nad stôl, alebo ho urobiť horným riadkom tabuľky.
- Použite hlavičky stĺpcov a riadkov (alebo oboje), aby ste definovali obsah stĺpcov a riadkov. Zvážte použitie nejakého typu zvýraznenia pre tieto hlavičky stĺpcov a riadkov.
- Zarovnajte textové stĺpce doľava (pokiaľ nejde o jednoduché položky abecedných znakov). Zarovnajte textové stĺpce doľava s ich nadpismi.
- Pravým zarovnaním alebo desatinovým zarovnaním číselných údajov ich centrovať pod nadpisom.
- Uveďte štandardné meracie jednotky (ft, mm, gal.) v hlavičke stĺpca alebo riadku namiesto s každou položkou v stĺpci alebo riadku.
- Poskytnite stručnú diskusiu o hlavnom trende v tabuľke—čo chcete, aby čitatelia si všimli.
Zvýraznenie
Dokumentácia softvéru zvyčajne používa veľa zvýraznenia. Zvýraznenie tu odkazuje na tučné písmo, kurzívu, alternatívne písma, veľké písmená, úvodzovky a iné typografické triky používané na prilákanie pozornosti k textu. Nasledujúce obsahuje niektoré štandardné pokyny pre zvýraznenie. Pre podrobnejšiu diskusiu si pozrite kapitolu o vyzdvihovanie.
- Vypracujte plán na používanie zvýraznenia a použite ho konzistentne. Používajte zvýraznenie z konkrétnych, funkčných dôvodov. Vyhnite sa nadmernému zvýrazneniu; vyhnite sa zložitým schémam zvýraznenia.
- Zvážte použitie tohto pomerne štandardného schémy zvýraznenia:
- Pre jednoduché zdôraznenie používajte kurzívu.
- Použite **tučné písmo** pre príkazy, **tlačidlá na obrazovke** a **možnosti v ponuke**.
- Použite kurzívu pre premenné, pre ktoré musia používatelia poskytnúť svoje vlastné slová.
- Použite alternatívne písmo pre text zobrazený na obrazovke alebo text, ktorý musia používatelia písať.
- Pre názvy obrazoviek a polí používajte štýl písania veľkých písmen, ktorý je zobrazený na obrazovke, ale žiadne iné zvýraznenie.
- Použite veľké písmeno na začiatku názvov kľúčov, ale žiadne iné zvýraznenie.
- Pre rozšírené zdôraznenie použite formát oznámenia.
Okraje, Odstupy a Zarovnanie
Ako bolo spomenuté v sekcii o nadpisoch, pekným dotykom je odsadiť text o jeden až dva palce, pričom nadpisy zostanú na ľavých okrajoch. Tento štýl robí dve veci: zvýrazňuje nadpisy a skracuje dĺžku riadkov bežného textu.
Písma a Farby
Tu sú niektoré návrhy týkajúce sa písiem a farieb:
- Použite iba jedno alternatívne písmo, maximálne dve. Napríklad môžete použiť Arial pre nadpisy, Times New Roman pre text pre telo a Courier New pre text, ktorý sa zobrazuje na obrazovke alebo ktorý musia používatelia zadávať.
- Ak používate farbu, použite ju minimálne. Napríklad, ak máte čierny text na bielom pozadí, môžete zvoliť inú farbu pre nadpisy. Tú istú farbu môžete použiť aj pre názvy obrázkov a tabuliek, ako aj pre označenia oznamov (skutočné označenia "Poznámka," "Varovanie," "Opatrnosť" a "Nebezpečenstvo" na oznamoch).
- Vyhnite sa neobvyklým kombináciám farieb pozadia a textu. Napríklad, fialový alebo červený text na čiernom pozadí je hrozne ťažko čitateľný. Držte sa čierneho textu na bielom alebo šedom pozadí, pokiaľ neexistuje silný funkčný dôvod pre inú kombináciu farieb.
Ocenil by som vaše myšlienky, reakcie a kritiku týkajúcu sa tejto kapitoly: tvoja odpoveď.
