Príručky

A príručka, ako ho tu definujeme, je kombináciou nasledujúceho:

• koncept informácie
• pokyny informácie
• referenčné informácie

všetko zamerané na konkrétnu tému pre potreby konkrétneho publika. Ak absolvujete kurz technického písania s touto knihou, váš projekt príručky musí zahrnúť nejakým spôsobom každý z týchto troch prvkov. Navyše by tieto prvky mali byť prirodzeným, logickým "fitom" pre váš projekt príručky.

Určite sa pozrite na príklady.

Infografika generovaná NotebookLM o tejto kapitole

Základy príručky

Koncepty. Konceptuálne informácie vysvetľujú, ako veci fungujú, ako sú veci poskladané. Na komplexnejšie inštrukcie musíte poznať niektoré koncepty, teóriu, pozadie, princípy, aby ste mohli vykonať pokyny. Zvážte príklad softvérovej funkcie, ktorá vám umožňuje upraviť alebo vytvoriť svoju vlastnú farbu. Použitie niečoho ako Photoshop, Illustration, CorelDraw alebo Paint Shop Pro na to—skutočné tlačidlá a posuvníky—je jednoduché. Ale pochopiť, čo je odtieň, intenzita, jas, sýtost, hustota, kontrast, RGB—to je ťažké. Musíte poznať teóriu farieb v počítači, aby ste vytvorili potrebnú farbu.

Zvážte ďalší príklad: jednoduché príkazy súborového systému Linux —ls, cd, cp, mv, pwd. Aby ste mohli tieto príkazy používať, musíte rozumieť tomu, čo sú súbory a adresáre, a pravdepodobne aj tomu, čo je operačný systém, ako aj zástupné znaky. Skutočne nemôžete pochopiť, ako používať tieto príkazy —sledovaním pokynov pomocou nich —pokým nerozumiete týmto základným konceptom.

Návody. Ak rozumiete základným konceptom, môžete inteligentne sledovať postupy krok za krokom. Pokyny sú tie známe číslované zoznamy, ktoré vás starostlivo prevedú postupom. Pokyny sú všade, na obaloch produktov, v používateľských príručkách, ktoré prichádzajú s prístrojmi a počítačmi.

Referencia. Posledná kategória informácií zahŕňa informačné zdroje na vyhľadávanie alebo rýchle odkazy. Ak ste sledovali príklad súborového systému vyššie, museli ste sa najprv naučiť a osvojiť si koncepty súborov, adresárov a zástupných symbolov. Potom ste mohli sledovať a pochopiť pokyny na zmenu adresárov, kopírovanie, mazanie alebo presúvanie súborov. Po nejakom čase už však pokyny nepotrebujete, ale občas máte špeciálne požiadavky, ktoré nie sú pokryté v sekcii pokynov, alebo si nemôžete spomenúť na určité postupy, ktoré boli v sekcii pokynov uvedené. Teraz je čas na to, aby ste potrebovali základné referenčné informácie: jednoducho prejdete do tejto sekcie a rýchlo si to vyhľadáte.

A tak po dlhšom čase už ani nepotrebuješ sekciu konceptov ani sekciu pokynov: si si na tieto postupy tak zvyknutý, že ich vieš naspamäť. Ale občas zabudneš nejaký malý detail alebo máš nejakú špeciálnu úlohu, ktorú si ešte nikdy predtým nerobil —vtedy ideš do referenčnej sekcie. Pravdepodobne by si mohol oddeliť sekcie konceptov a pokynov a vyhodiť ich. Všetko, čo kedy budeš potrebovať, je referenčná sekcia.

Príručka Formát a Štýl

V kurze technického písania, ktorý používa túto knihu, sa môže očakávať, že budete dodržiavať konkrétne pokyny na používanie nadpisov, zoznamov, oznámení, grafiky, tabuliek, dokumentácie a úvodov:

Príručka prototypu. Z odkazu nižšie si môžete stiahnuť vzorovú verziu smernice. Obsahuje všetky potrebné stránky vo vyhovujúcom formáte. V tomto dokumente Word sú zahrnuté štýly odsekov a znakov, ktoré uľahčia vašu prácu a pridajú niektoré profesionálne zručnosti do vášho repertoáru.

Príručka prototypu

Obsah prototypu. Prototyp pre obsah je mimoriadne užitočný: poskytuje vám štýly Word na vytvorenie profesionálne vyzerajúceho obsahu. Je ťažké správne nastaviť zarovnanie vľavo a vpravo a líderové bodky:

Prototyp osnovy obsahu

Príklady príručky

Tu sú niektoré odkazy na príklady príručiek. Majte na pamäti, že v príkladoch sú určité problémy, na ktoré som väčšinou upozornil. Niektoré z nich sú na hranici príručiek. To, čo pre mňa robí príručku, je prítomnosť konceptuálnej diskusie, pokynov a referenčných informácií.

Určite si pozrite príklady.

AI výzvy pre príručky

Kontrolné zoznamy, ktoré zvyčajne ostávajú nepoužité, môžu byť po určitých úpravách použitými ako zdroj pre AI výzvy. Skopírujte nasledujúce, vložte to do AI systému, ako je Google's Gemini, a pozrite sa, čo ste mohli prehliadnuť.

Poznámka: Všetky odkazy na obsah, formát, štýl techdocs alebo jeho komponenty nájdete v online učebnica technického písania.

čoskoro!

Oceňujem vaše myšlienky, reakcie, kritiku týkajúcu sa tejto kapitoly: tvoja odpoveď—David McMurrey.