Kérjük, kattintson ide a segítségért. David McMurrey fizessen webtárhelyért:
Adományozz bármilyen kis összeget, amit tudsz!
Az Online Műszaki Írás továbbra is ingyenes marad.
Itt van két meghatározás az útmutató dokumentumokról:
- A útmutató egy dokumentum, kiadvány vagy digitális erőforrás, amely lépésről lépésre útmutatást, tippeket és információt nyújt arról, hogyan lehet konkrét feladatokat végrehajtani, termékeket használni vagy összetett fogalmakat megérteni. Egy útmutató tartalmazhat hibaelhárítási információkat, linkeket kapcsolódó közösségekhez és kapcsolódó kutatásokhoz.
- Másutt, a kormányzati világban, útmutató dokumentumok, vagy irányítás A dokumentumok célja, hogy hasznos információkat nyújtsanak a nyilvánosság számára, például tisztázzák a meglévő törvények vagy szabályozások szerinti kötelezettségeket, vagy tájékoztatást adjanak a hivatal eljárásairól. Más szavakkal, a bonyolult jogi nyelvezetet lefordítják az adminisztratív szabályokról, hogy a nyilvánosság képes legyen betartani azokat.
Útmutató Dokumentumok
Egy útmutató dokumentum alapvetően egy utasításkészlet, de más forrásokat is tartalmaz, hogy szélesebb körben hasznos legyen.
A fejezet áttekintése a utasítások, láthatja, hogy az utasításokat egy szakasz követi, amely a szükséges felszerelést és anyagokat részletezi, valamint egy szakasz, amely a folyamat lépéseit részletezi, gyakran számozott függőleges lista formátumban. Tartalmazzon egy ilyen szakaszt az útmutató dokumentumában—de ez még nem minden!
Útmutató Alapok: Utasítások
A következő címsorok közül az első hat elem bármilyen általános utasítássorozatnak tűnik—de a többi nem!
Válaszd ki a megfelelő helyet
Válaszd ki a Kert Méretét
Válasszon zöldségeket
Határozd meg, hol és mikor ültess!
Határozd meg, mikor ültess, mit
Tervezd meg a kertet
Kertészeti Eszközök Beszerzése
Az Egyesült Államok Zöldségkertészeti Zónái
Átlagos amerikai szezonális hőmérsékletek
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 a következőből Zöldségeskert kezdőknek: A teljes útmutató
Még az első hat tétel hossza és részletessége is meghaladja azt, amit egy átlagos kétoldalas használati útmutatótól várnál, nem is beszélve a szép díszítőképekről.
Itt van egy újabb címekből álló lista, amely egy sokkal hosszabb dokumentumot jelez, mint egy vagy két oldalas utasításkészlet:
Kerti Helyszín Kiválasztás
Növény Kiválasztás
Kertterv: Hely, Forgatás
Talajelőkészítés
Megtermékenyítés
Ültetés
Öntözés
Gyomirtás
Mulcsozás
Kártevőirtás
Aratás
Kertészkedés: Amit érdemes és amit nem érdemes tenni
Engedéllyel átdolgozva от Texas-i Otthoni Zöldségkertészeti Útmutató Joseph Masabn, Texas A&M AgriLife.
Kiegészítők: Extrák
Amit egy utasítássorozatot vezérlővé tesz, azok a kiegészítők, amelyeket a részben tárgyalunk.
Elmélet, Fogalmi Információ
A képkészítő és -manipuláló szoftverek komoly felelősséggel tartoznak a színkurvák, a rétegmaszkok, a csatornák magyarázatáért. A csodálatos ingyenes képkezelő szoftver, a GIMP, jó magyarázatokat ad a fogalmakról a következő címen: Alapvető Színgörbék:
|
Pixel Színek — által Pat David Ne feledd, hogy minden pixel három szín kombinációjával van reprezentálva: Piros, Zöld és Kék. A GIMP-ben (jelenleg 8-bites) ez azt jelenti, hogy minden RGB szín értéke 0-tól 255-ig terjedhet, és e három szín különböző szintekkel való kombinálása minden színt eredményez, amit a képedben láthatsz. Ha mindhárom csatorna értéke 255, akkor az eredmény szín tiszta fehér lesz. Ha mindhárom csatorna értéke 0, akkor az eredmény szín tiszta fekete lesz. Ha mindhárom csatorna ugyanazzal az értékkel bír, akkor egy szürke árnyalatot kapsz (például a (128,128,128) egy középső szürke színt jelent). Itt vannak néhány színszabályozás a GIMP-ben: 
Ahogy látható, több a kék, mint bármi más (végül is ez egy kékes pixel), amit a zöld követ, majd egy kis pirossal. Ha megváltoztatnánk minden csatorna értékeit, de megtartanánk a vörös, zöld és kék közötti arányt, akkor ugyanazt a színt kapnánk, csak világosabbá vagy sötétebbé tennénk a pixelt valamilyen mértékben. |
Hibaelhárítási információk
A hibaelhárítási információk gyakran egy "próbáld ezt, próbáld azt" keretrendszerben vannak formázva.
|
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, hogy megbizonyosodjon arról, hogy biztonságosan csatlakozik a számítógép hátsó részéhez és a konnektorhoz. ▢ Megoldás 1: Ha a számítógép nem indul, először ellenőrizd az tápkábelt, hogy megbizonyosodj róla, hogy biztonságosan csatlakozik a számítógép hátsó részéhez és a konnektorhoz. ▢ Megoldás 2: Ha konnektorba dugva van, győződjön meg arról, hogy az működőképes. A konnektor ellenőrzéséhez csatlakoztasson 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 egy túlfeszültségvédőhöz van csatlakoztatva, ellenőrizd, hogy be van-e kapcsolva. Lehet, hogy a túlfeszültségvédőt újra kell indítanod úgy, hogy kikapcsolod, majd visszakapcsolod. Azt is ellenőrizheted, hogy működik-e helyesen, ha egy lámpát vagy más eszközt csatlakoztatsz a túlfeszültségvédőhöz. ▢ Megoldás 4: Ha laptopot használ, lehet, hogy az akkumulátor nincs feltöltve. Dugja be az AC adaptert a falba, majd próbálja meg bekapcsolni a laptopot. Ha még mindig nem indul el, lehet, hogy pár percet várnia kell, majd próbálja meg újra. |
Forrás: Engedély alapján átdolgozta Számítógép Alapok - Alapvető Hibaelhárítási Technikák
Közösségek és Fórumok
Kapcsolódó források
AI Ötletek Útmutató Dokumentumokhoz
A listák, amelyeket általában nem olvasnak el, módosítással az AI promptok forrásaként használhatók. Másold ki a következőt, illeszd be egy AI rendszerbe, például a Google Gemini-be, és nézd meg, mit hagytál ki.
Megjegyzés: A techdok mentén elhelyezkedő tartalomra, formátumra, stílusra vagy azok összetevőire vonatkozó összes hivatkozás a következő helyen található. online műszaki írás tankönyv.
hamarosan!
Irányelvek dokumentumok
A bemutatottak szerint az irányelvek az adminisztratív szabályokat olyan információvá fordítják, amelyet a hétköznapi, nem jogi végzettségű emberek is érthetnek.
- Egy közigazgatási szabályt erősen jogi nyelvezet és gyakran mérnöki nyelv jellemez. Íme egy példa részlet: B ALFEJEZET: KÜLSŐ ÉGÉ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 Minőségügyi Bizottság, 2017-től hatályos.
- Egy iránymutató dokumentum viszont megpróbálja érthető nyelven elmagyarázni az adminisztratív szabály kulcsfontosságú pontjait, hogy a hétköznapi állampolgár tudjon megfelelni a szabálynak. Íme egy példaként idézett részlet: Kültéri égetés. Texas Környezetvédelmi Minőség 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 adminisztratív szabályt, amely kegyesen rövid—10 oldal alatt. Íme néhány lehetőség:
Fontolja meg, hogy kiválasszon és írjon az alábbiak egyikéről:
- 361. fejezet. Szilárd Hulladék Kezelési Törvény. Ez a Texas használt gumiabroncsokra vagy azbeszt szabályaira vonatkozik.
- Használti olaj újrahasznosítása. Texas Környezetvédelmi Minőségbiztosítási Bizottság
- Használatból kivont vagy hulladék gumiabroncsok kezelése
- 2201. fejezet, Ökölvívás. Ez nem a kartonról szól!
- 2100. fejezet, Engedélyezés, Regisztráció és Működés (borbélyüzletek)
- 5300. fejezet, Házasság és Családterápia
Irányelv dokumentum tervezés
Néhány javaslat egy útmutató dokumentum írásához:
- Ne felejtsd el bemásolni a konkrét szabályt függelékben. Néhány szabály dokumentum elég hosszú lehet. Csak a vonatkozó szabályok szakaszaid másolhatod be az útmutatásodban.
- A lehetőségekhez képest minél több függeléket kell tartalmazni, különös figyelmet fordítva az „alapmintára” vonatkozóakra.
- Öltöztesd fel az útmutató dokumentumodat grafikával, címsorokkal és alcímekkel, valamint más jellemzőkkel, amelyek valódi útmutató dokumentumnak tűnnek.
AI Útmutató Dokkumentumokhoz
A listák, amelyeket általában nem olvasnak el, módosítással AI indítók forrásaként használhatók. Másolja az alábbi szöveget, illessze be egy AI rendszerbe, például a Google Gemini-ba, és nézze meg, mit hagyott ki.
Megjegyzés: Minden hivatkozás a techdocs tartalmára, formátumára, stílusára vagy annak összetevőire a következő helyen található: online műszaki írás tankönyv.
Hamarosan!
Kapcsolódó információk
Irányelvek Dokumentumok. Amerikai Mezőgazdasági Minisztérium
HHS Útmutató Portál. Az Egyesült Államok Egészségügyi és Humán Szolgáltatások Minisztériuma
Értékelném a gondolataidat, reakcióidat, kritikáidat ezzel a fejezettel kapcsolatban: a válaszod—David McMurrey.
