Kérjük, kattintson ide, hogy segítsen. David McMurrey fizetni a webtárhelyért:
Adományozz bármilyen kis összeget, amit csak tudsz!
Az online műszaki írás továbbra is ingyenes marad.
Itt vannak az útmutató dokumentumok két meghatározása:
- Egy útmutató Egy útmutató olyan dokumentum, kiadvány vagy digitális forrás, amely lépésről lépésre szóló útmutatást, tippeket és információkat nyújt arról, hogyan kell meghatározott feladatokat elvégezni, termékeket használni vagy összetett fogalmakat megérteni. Egy útmutató továbbá tartalmazhat hibakeresési információkat, kapcsolódó közösségekhez vezető hivatkozásokat és kapcsolódó kutatásokra mutató hivatkozásokat.
- Másutt, a kormányzati világban, útmutató dokumentumok, vagy útmutatás A dokumentumok célja, hogy hasznos információt nyújtsanak a nyilvánosságnak, például azzal, hogy tisztázzák a hatályos törvény vagy rendelet szerinti kötelezettségeket, vagy tájékoztatást adnak a hatósági eljárásokról. Más szóval az adminisztratív szabályok bonyolult jogi nyelvezetét lefordítják, hogy a nyilvánosság képes legyen ezeket a szabályokat betartani.
Útmutató dokumentumok
Egy útmutató dokumentum lényegében egy utasítások halmaza, de más forrásokkal kiegészítve, hogy szélesebb körben hasznos legyen.
A fejezet áttekintése a(z) utasítások, látod, hogy az utasításokat egy olyan rész határolja, amely részletezi a szükséges felszerelést és anyagokat, valamint egy olyan rész is, amely részletezi az eljárási lépéseket, gyakran számozott, függőleges lista formájában. Tüntess fel egy ilyen szakaszt az útmutató dokumentumodban—de ez még nem minden!
Útmutató alapjai: Utasítások
Az alábbi címsorok közül az első hat bármely gyakori utasítássorozatnak tűnik—de a többi nem!
Válassza ki a megfelelő helyet.
Válassza ki a kert méretét
Válasszon zöldségeket
Határozza meg, hol és mikor ültessen
Határozza meg, mikor mit ültessen
Készítse el a kerttervet
Szerezzen be kerti szerszámokat
Az Egyesült Államok zöldségkertészeti övezetei
Az Egyesült Államok átlagos évszakos hőmérsékletei
Gyakori zöldségkertészeti kártevők és védekezés
Online zöldségkertészeti források
Zöldségkertészeti fórumok és közösségek
Engedéllyel átdolgozva Zöldségkertészkedés kezdőknek: A teljes útmutató
Még az első hat pont hossza és részletessége is nagyobb, mint amit egy általános, kétoldalas útmutatótól várnál, nem is beszélve a szép díszítő képekről.
Íme egy másik címsorok listája, amely egy jóval hosszabb dokumentumra utal, mint egy- vagy kétoldalas útmutatás:
Kert helyének kiválasztása
Kivágás kiválasztása
Kertterv: Elhelyezkedés, forgatás
Talaj előkészítése
Megtermékenyítés
Ültetés
Öntözés
Gyomirtás
Talajtakarás
Kártevőirtás
Betakarítás
Kertészkedés – mit tegyünk és mit ne tegyünk
Engedéllyel átdolgozva Texas otthoni zöldségkertészeti útmutató Joseph Masabn, Texas A&M AgriLife.
Útmutató kiegészítők: Extrák
Amitől egy utasítássorozat útmutatóvá válik, azok a szakaszban tárgyalt kiegészítések.
Elmélet, fogalmi információ
A képek létrehozására és manipulálására szolgáló szoftverek komoly felelősséggel tartoznak a színgörbék, rétegmaszkok és csatornák magyarázatáért. A csodálatos, ingyenes GIMP képszerkesztő jó magyarázatot ad a fogalmakról itt Alapvető színgörbék:
|
Pixelek színei — Pat David által Ne feledd, minden pixel három szín kombinációjával van ábrázolva: vörös, zöld és kék. A GIMP-ben (jelenleg 8 bites) ez azt jelenti, hogy az egyes RGB-színek értéke 0–255 között lehet, és ezen három szín különböző szintjeinek kombinálásával az egyes csatornákban előállíthatók az összes szín, amit a képen látsz. Ha mindhárom csatorna értéke 255, akkor a kapott szín tiszta fehér lesz. Ha mindhárom csatorna értéke 0 –akkor a kapott szín tiszta fekete lesz. Ha mindhárom csatorna ugyanazt az értéket tartalmazza, akkor egy szürke árnyalatot kapunk (például a (128,128,128) egy középszürke szín lenne). Íme néhány színbeállítás a GIMP-ben: 
Ahogy látható, több kék van benne, mint bármi más (végülis egy kékes pixelről van szó), ezt követi a zöld, majd egy csipetnyi piros. Ha megváltoztatnánk az egyes csatornák értékeit, de megtartanánk a vörös, zöld és kék arányát, akkor ugyanazt a színt kapnánk, csak a pixel világosabbá vagy sötétebbé válna valamennyivel. |
Hibaelhárítási információk
A hibaelhárítási információkat gyakran egy „próbáld ezt, próbáld azt” szerkezetben adják meg.
|
Probléma: A bekapcsológomb nem indítja el a számítógépet. ▢ Megoldás 1: Ha a számítógépe nem indul el, kezdje azzal, hogy ellenőrzi a tápkábelt, és meggyőződik róla, hogy az szorosan be van dugva a számítógépház hátuljába és a hálózati aljzatba. ▢ Megoldás 1: Ha a számítógépe nem indul, kezdje azzal, hogy ellenőrzi a tápkábelt, és meggyőződik róla, hogy az biztonságosan be van-e dugva a számítógépház hátuljába és a konnektorba. ▢ Megoldás 2: Ha konnektorba van dugva, győződjön meg róla, hogy a konnektor működőképes. A konnektor ellenőrzéséhez bedughat egy másik elektromos készüléket, például egy lámpát. ▢ Megoldás 3: Ha a számítógép túlfeszültség-védőre van csatlakoztatva, ellenőrizze, hogy az be van-e kapcsolva. Előfordulhat, hogy vissza kell állítania a túlfeszültség-védőt úgy, hogy kikapcsolja, majd újra bekapcsolja. Olyan lámpát vagy más készüléket is csatlakoztathat a túlfeszültség-védőhöz, hogy ellenőrizze, megfelelően működik-e. ▢ Megoldás 4: Ha laptopot használ, előfordulhat, hogy az akkumulátor nincs feltöltve. Csatlakoztassa a hálózati adaptert a konnektorba, majd próbálja meg bekapcsolni a laptopot. Ha még mindig nem indul el, előfordulhat, hogy várnia kell néhány percet, majd próbálja újra. |
Forrás: Az engedéllyel átdolgozva a következőből: Számítógép alapjai - Alapvető hibaelhárítási technikák
Közösségek és fórumok
Kapcsolódó források
AI-utasítások útmutató dokumentumokhoz
Az ellenőrző listák, amelyeket általában nem olvasnak el, némi módosítással felhasználhatók mesterséges intelligencia promptok forrásaként. Másolja ki a következőt, illessze be egy olyan MI-rendszerbe, mint a Google Gemini, és nézze meg, mit hagyhatott ki.
Megjegyzés: A techdocs tartalmára, formátumára, stílusára vagy annak összetevőire vonatkozó összes hivatkozás megtalálható a online műszaki szövegírás tankönyv.
Hamarosan!
Útmutató dokumentumok
Ahogyan itt bemutatva, az útmutató dokumentumok az adminisztratív szabályokat olyan információvá fordítják, amelyet a joghoz nem értő, hétköznapi emberek is el tudnak olvasni és megérteni.
- Egy közigazgatási szabályt erősen jogias nyelvezet és gyakran mérnöki nyelvezet jellemez. Íme egy példarészlet: B. ALFEJEZET: KÜLTÉRI ÉGETÉS §§111.201, 111.203, 111.205, 111.207, 111.209, 111.211, 111.213, 111.215, 111.217, 111.219, 111.221. Texasi Környezetvédelmi Bizottság, hatályos 2017-től.
- Egy útmutató dokumentum viszont megpróbálja érthető nyelven elmagyarázni a közigazgatási szabály lényeges pontjait, hogy a hétköznapi állampolgár betarthassa a szabályt. Íme egy példarészlet: Szabadtéri égetés. Texas Környezeti Minőségügyi Bizottság, 2015.
Projektlehetőségek
Ha elég bátor lélek vagy ahhoz, hogy útmutató dokumentumot írj, próbálj meg találni egy irgalmasan rövid közigazgatási szabályt—amely kevesebb mint 10 oldal. Íme néhány lehetőség:
Fontolja meg, hogy válasszon egyet a következők közül, és írjon róla:
- 361. fejezet. Szilárd hulladék ártalmatlanításáról szóló törvény. Ez a Texas használt gumiabroncsokra vagy azbesztre vonatkozó szabályait érinti.
- Használt olaj újrahasznosítása. Texasi Környezeti Minőségügyi Bizottság
- Használt vagy selejtezett gumiabroncsok kezelése
- 2201. fejezet, Ökölvívás. Ez nem a kartonról szól!
- 2100. fejezet, Engedélyezés, Regisztráció és Üzemeltetés (borbélyüzleteké)
- 5300. fejezet, Házasság- és családterápia
Útmutató dokumentum tervezése
Néhány javaslat egy iránymutató dokumentum megírásához:
- Ne felejtsd el mellékletként beilleszteni a tényleges szabályt. Néhány szabálydokumentum elég hosszú lehet. Elég, ha csak azokat a szabályszakaszokat másolod be, amelyekre az útmutatásod vonatkozik.
- Tartalmazza a lehetőségekhez mérten minél több mellékletet—különösen azokat, amelyek „sablon” jellegűek.
- Díszítse a tájékoztató dokumentumát grafikával, címsorokkal és alcímekkel, valamint egyéb elemekkel, amelyek valódi iránymutató dokumentumnak láttatják.
AI-utasítások útmutató dokumentumokhoz
Az ellenőrző listák, amelyeket általában nem olvasnak el, némi módosítással felhasználhatók mesterséges intelligencia-parancsok (promptok) forrásaként. Másold ki a következőt, illeszd be egy olyan mesterséges intelligencia-rendszerbe, mint a Google Gemini, és nézd meg, mit hagyhattál ki.
Megjegyzés: A techdocsra vagy annak összetevőinek tartalmára, formátumára és stílusára vonatkozó összes hivatkozás megtalálható a online, műszaki írásról szóló tankönyv.
Hamarosan!
Kapcsolódó információk
Útmutató dokumentumokAz Egyesült Államok Mezőgazdasági Minisztériuma
HHS útmutatási portál. Az Egyesült Államok Egészségügyi és Emberi Szolgáltatások Minisztériuma
Értékelném a gondolataidat, reakcióidat, kritikádat ezzel a fejezettel kapcsolatban: a válaszod—Dávid McMurrey.
