Prosím kliknite sem, aby ste pomohli. David McMurrey zaplaťte za webhosting:
Darujte akúkoľvek malú sumu, ktorú môžete!
Online technické písanie zostane zadarmo.
Tu sú dva pojmy pre sprievodné dokumenty:
- A sprievodca je dokument, publikácia alebo digitálny zdroj, ktorý poskytuje krok za krokom pokyny, tipy a informácie o tom, ako vykonávať konkrétne úlohy, používať produkty alebo chápať zložité pojmy. Príručka môže tiež obsahovať informácie o riešení problémov, odkazy na súvisiace komunity a odkazy na súvisiaci výskum.
- Inde, vo vládnom svete, sprievodné dokumenty, alebo usmernenie dokumenty sú určené na poskytovanie užitočných informácií verejnosti, ako sú objasnenie povinností podľa existujúceho zákona alebo predpisu, alebo poskytovanie informácií o postupoch agentúry. Inými slovami, prekladajú zložitý právny jazyk administratívnych pravidiel, aby verejnosť mohla dodržiavať tieto pravidlá.
Sprievodné dokumenty
Sprievodný dokument je v svojej podstate súborom pokynov, ale s ďalšími zdrojmi, aby bol užitočnejší.
Revízia kapitoly o pokyny, vidíte, že pokyny sú xxed sekciou podrobne popisujúcou potrebné vybavenie a zásoby a sekciou podrobne popisujúcou procedurálne kroky, často vo formáte číslovaného vertikálneho zoznamu. Zahrňte do svojho sprievodcu dokumentom—ale to nie je všetko!
Základy sprievodcu: Pokyny
Prvých šesť položiek v nasledujúcom zozname nadpisov vyzerá ako bežná sada inštrukcií—ale ostatné nie!
Vyberte si správne miesto
Vyberte veľkosť záhrady
Vyberte zeleninu
Určte, kde a kedy zasadiť
Určite, kedy sadiť čo
Navrhnite plán záhrady
Získajte záhradné náradie
Zóny záhradníctva v USA pre zeleninu
Priemerné sezónne teploty v USA
Bežné škodcovia v záhradníctve a ich kontrola
Online Zdroje pre Záhradníčenie s Rádiom
Fóra a komunity o pestovaní zeleniny
Prispôsobené s povolením od Záhradničenie s zeleninou pre začiatočníkov: Kompletný sprievodca
Aj dĺžka a podrobnosti prvých šiestich položiek sú väčšie, než by ste očakávali v obyčajnej dvojstranovej sade pokynov, nieto ešte krásne dekoratívne obrázky.
Tu je ďalší zoznam nadpisov, ktorý predznamenáva oveľa dlhší dokument ako jednoplatformový alebo dvojstranový súbor pokynov:
Výber miesta pre záhradu
Výber plodiny
Záhradný plán: Umiestnenie, Rotácia
Príprava pôdy
Hnojenie
Sadenie
Polievanie
Kontrola buriny
Mulčovanie
Ochrana pred škodcami
Zber
Záhradníctvo: Čo robiť a čo nerobiť
Prispôsobené s povolením od Sprievodca domácim záhradníctvom zeleniny v Texase Joseph Masabn, Texas A&M AgriLife.
Príručka Dodatky: Extra
Čo robí súbor pokynov sprievodcom, sú doplnky uvedené v sekcii.
Teória, Konceptuálne Informácie
Softvér na vytváranie a manipuláciu s obrázkami má vážnu zodpovednosť vysvetliť farebné krivky, masky vrstiev, kanály. Úžasný bezplatný softvér na obrázky GIMP má dobré vysvetlenie konceptov na Základné farebné krivky:
|
Pixelové farby — od Pat Davida Pamätajte, že každý pixel je reprezentovaný kombináciou 3 farieb: Červená, Zelená a Modrá. V GIMPe (aktuálne na 8-bit) to znamená, že každá RGB farba môže mať hodnotu od 0 do 255, a kombinovaním týchto troch farieb s rôznymi úrovňami v každom kanáli vzniknú všetky farby, ktoré môžete vidieť vo vašej obrázku. Ak majú všetky tri kanály hodnotu 255, potom bude výsledná farba čistá biela. Ak majú všetky tri kanály hodnotu 0, potom bude výsledná farba čistá čierna. Ak majú všetky tri kanály rovnakú hodnotu, dostanete odtieň šedej (napríklad 128,128,128 by bol stredne šedý odtieň). Tu sú niektoré farbné nastavenia v GIMPe: 
Ako vidíte, je tu viac modrej ako čohokoľvek iného (predsa len je to modro-žltý pixel), nasleduje zelená a potom štipka červenej. Ak by sme zmenili hodnoty každého kanála, ale zachovali pomer medzi červenou, zelenou a modrou rovnaký, potom by sme zachovali rovnakú farbu a len by sme pixel svetlili alebo ztemnili o nejakú hodnotu. |
Informácie o riešení problémov
Informácie o odstraňovaní problémov sú často štruktúrované ako framework „skús toto, skús tamto“.
|
Problém: Tlačidlo napájania nezapne počítač ▢ Riešenie 1: Ak sa váš počítač nespúšťa, začnite kontrolou napájacieho kábla, aby ste potvrdili, že je bezpečne zapojený do zadnej časti počítačovej skriniek a do elektrickej zásuvky. ▢ Riešenie 1: Ak sa váš počítač nespustí, začnite kontrolou napájacieho kábla, aby ste sa uistili, že je bezpečne zapojený do zadnej časti počítača a do elektrickej zásuvky. ▢ Riešenie 2: Ak je zapojené do zásuvky, uistite sa, že ide o funkčnú zásuvku. Na skontrolovanie zásuvky môžete zapojiť iné elektrické zariadenie, ako je lampa. ▢ Riešenie 3: Ak je počítač zapojený do prepäťovej ochrany, skontrolujte, či je zapnutá. Možno budete musieť resetovať prepäťovú ochranu tak, že ju vypnete a potom znova zapnete. Môžete tiež zapojiť lampu alebo iné zariadenie do prepäťovej ochrany, aby ste overili, či funguje správne. ▢ Riešenie 4: Ak používate prenosný počítač, batéria nemusí byť nabitá. Zasuňte AC adaptér do zásuvky a potom sa pokúste zapnúť prenosný počítač. Ak sa stále nespustí, možno budete musieť počkať niekoľko minút a skúsiť to znova. |
Zdroje: Upravené so súhlasom z Základy počítača - Základné techniky riešenia problémov
Komunity a fóra
Súvisiace zdroje
AI výzvy pre sprievodné dokumenty
Zoznamy, ktoré sa zvyčajne nečítajú, môžu byť použité ako zdroj pre AI výzvy s niektorými úpravami. Skopírujte nasledujúce, vložte to do AI systému, ako je Google Gemini, a zistite, čo ste možno prehliadli.
Poznámka: Všetky odkazy na obsah, formát, štýl techdocs alebo jeho komponenty môžu byť nájdené v online učebnica technickej dokumentácie.
Čoskoro prichádza!
Rámcové dokumenty
Ako je tu uvedené, usmerňujúce dokumenty prekladajú administratívne pravidlá do informácií čitateľných pre bežných nepravníkov.
- Administratívne pravidlo je vyznačené ťažkým právnickým jazykom a často aj technickým jazykom. Tu je príklad výňatku: SUBKAPITOLA B: EXTERNÉ PÁLENIE §§111.201, 111.203, 111.205, 111.207, 111.209, 111.211, 111.213, 111.215, 111.217, 111.219, 111.221. Texaská komisia pre ochranu životného prostredia, účinná od roku 2017.
- Dokument o usmerneniach na druhej strane sa snaží vysvetliť prístupným jazykom kľúčové body v administratívnej norme, aby umožnil bežnému občanovi dodržiavať túto normu. Tu je príklad výňatku: Vonkajšie pálenie. Komisia pre environmentálnu kvalitu Texasu, 2015.
Možnosti projektu
Ak ste dostatočne odvážna duša na to, aby ste napísali usmerňujúci dokument, pokúste sa nájsť administratívne pravidlo, ktoré je milosrdne stručné—pod 10 strán. Tu sú niektoré možnosti:
Zvážte výber a písanie o jednom z týchto:
- Kapitola 361. Zákon o nakladaní s tuhým odpadom. Tento sa zaoberá pravidlami týkajúcimi sa použitých pneumatík alebo azbestu v Texase.
- Recyklácia použitého oleja. Texaská komisia pre environmentálnu kvalitu
- Správa použitých alebo vyhodených pneumatík
- Kapitola 2201, BoxovanieToto nie je o lepenke!
- Kapitola 2100, Licencovanie, Registrácia a Prevádzka (of holičstiev)
- Kapitola 5300, Manželstvo a rodinná terapia
Návrh sprievodného dokumentu
Niektoré návrhy na písanie dokumentu s pokynmi:
- Pamätajte, aby ste skopírovali skutočné pravidlo ako prílohu. Niektoré dokumenty s pravidlami môžu byť dosť dlhé. Môžete jednoducho skopírovať časti pravidiel, ktoré sú uvedené vo vašich pokynoch.
- Zahrňte toľko príloh, koľko je praktické—najmä tie, ktoré sú "štandardné."
- Oblečte svoj dokument s pokynmi do grafiky, nadpisov a podnadpisov, a ďalších funkcií, ktoré mu dodajú vzhľad skutočného dokumentu s pokynmi.
AI výzvy pre smernice dokumentov
Kontrolné zoznamy, ktoré zvyčajne zostávajú nečítané, môžu byť použité ako zdroj pre AI výzvy s niektorými úpravami. Skopírujte nasledujúce, vložte to do AI systému, ako je Google Gemini, a zistite, čo ste mohli premeškať.
Poznámka: Všetky odkazy na obsah, formát, štýl technických dokumentov alebo ich komponenty nájdete v online technická príručka písania.
čoskoro!
Súvisiace informácie
Informačné dokumenty. Ministerstvo poľnohospodárstva USA
Portál usmernení HHS. Ministerstvo zdravotníctva a sociálnych služieb USA
Oceňujem vaše myšlienky, reakcie a kritiku týkajúcu sa tejto kapitoly: tvoja odpoveď—David McMurrey.
