Bevezetés az útmutatókba

Az útmutatók egy különleges típusú szövegek, amelyek bemutatják, hogyan kell elvégezni egy feladatot vagy folyamatot. Lehetnek olyan egyszerűek, mint egy recept elkészítése, vagy olyan bonyolultak, mint egy szoftverrendszer működtetése.

Ebben a fejezetben megtanulhatja az útmutatók írásának különböző szempontjait, többek között:

• Címek (headings) használata a szervezettséghez
• Listák használata a világos, lépésről lépésre történő leíráshoz
• Különleges figyelmeztetések vagy figyelmeztető jelzések használata a hibák vagy balesetek elkerülésére

Az útmutatók célja

Az útmutatók fő célja, hogy irányítsák az olvasót egy feladat végrehajtásában. Ez magában foglalhatja:

• Fizikai feladatok irányítása (pl. bútor összeszerelés)
• Szoftver vagy technológia használatának oktatása
• Közigazgatási vagy hivatalos folyamatok végrehajtásának bemutatása

A lépések egyértelmű követésével az olvasó könnyebben érheti el a kívánt eredményt és kerülheti el a hibákat.

Az ilyen lehetőségek stílusához és formátumához lásd a listák fejezetét.

Részletekre való figyelem

Az útmutatók gyakran tartalmaznak részletes és világos leírást minden lépésről. A számozott vagy pontozott listák segítenek elkerülni a zűrzavart. Fontos, hogy külön figyelmeztetést adjon, ha egy lépés potenciális veszélyt hordoz.

Ebben a pontban valószínűleg már megtanulta a címek, listák és különleges figyelmeztetések használatát—az útmutató írása ezekkel most már nyilvánvalónak tűnik. Egyszerűen bontsa a leírást számozott, függőleges listákra, és helyezzen el külön figyelmeztetést a nyilvánvaló pontoknál. Ez még nem teljes, de jó kiindulópont.

Ebben a fejezetben áttekintjük az útmutatók néhány olyan jellemzőjét, amelyek bonyolultabbá tehetik azokat. Ezeket a szempontokat felhasználhatja a saját útmutatóinak megtervezéséhez is.

Írási tippek

• Biztosítsa, hogy minden lépés világos, és ne legyenek homályos szavak
• Használjon címeket és alcímeket az információ könnyebb megtalálásához
• Szükség esetén helyezzen el külön figyelmeztetést a veszélyek vagy hibák elkerülésére
• Olvassa át az útmutatót az olvasó szemszögéből, hogy biztosítsa a logikus folyamatot

Ezeknek az elveknek és tippeknek a követésével világos, hasznos és hatékony útmutatókat hozhat létre az olvasók számára.

AI Promtok felhasználói útmutatókhoz

A checklist-ek, amelyeket általában nem olvasnak el, felhasználhatók AI promptok forrásaként némi módosítással. Másolja ki az alábbiakat, illessze be egy AI rendszerbe, például a Google Gemini-be, és nézze meg, mit hagyott ki.

Megjegyzés: A tartalomra, formátumra és a jelentések komponenseire vonatkozó összes hivatkozás megtalálható az online műszaki írás tankönyvben.

AI promtok felhasználói útmutatókhoz

Tartalmazza-e az útmutató a következőket (helyesen formázva) ebben a sorrendben: átviteli üzenet, első és hátsó borítók, címlap; kiadás jelzés, tartalomjegyzék; előszó; fejezetek, függelékek (ha szükséges); mutató, hátsó borító. Bár lehet kreatív és játékos, a cím megfelelően jelzi-e a témát? Részletekért lásd útmutató címek. Ha a tartalomjegyzék és az ábrák listája (és táblázatok) vezető pontokat használnak, a oldalszámok jobbra vannak-e igazítva? Ha a tartalomjegyzék és ábrák listája jobbra tartalmaz oldalszámokat, használnak-e vezető pontokat? Részletekért lásd TOC és ábralisták. A bevezetés megfelelően ismerteti-e a témát, célt és a célközönséget? Tartalmaz-e alfejezeteket és a hatókört? Részletekért lásd Bevezetők. Tartalmaz-e az útmutató elegendő részletet, példát és magyarázatot a kijelentések és általánosítások megértéséhez? Hiányzik-e bármilyen fontos tartalom? Van-e felesleges tartalom? Van-e technikai hiba? Hiányzik-e kritikus információ? Tartalmaz-e nyilvánvalóan átvett, de dokumentálatlan információt? A hivatkozások APA, MLA vagy módosított IEEE stílus szerint vannak-e? Részletekért lásd Dokumentáció: átvett információforrások. Minden táblázat és dekoráció nélküli ábra rendelkezik-e leíró címmel (felirat) és forrással (ha szükséges)? Részletekért lásd Táblázatcímek. Minden táblázat és dekoráció nélküli ábra a releváns szöveghez közel helyezkedik el? Rövid magyarázó hivatkozások a táblázatok és ábrák előtt? Részletekért lásd Magyarázó hivatkozások. A szövegben standard cím- és alcímformátum van-e? Részletekért lásd Címek. A fő szakaszok (fejezetek) új oldalon kezdődnek-e a nyomtatott verzióban? Használ-e számozott függőleges listákat kötelező sorrendben, és pontozott listákat nem kötelező sorrendben? Van-e bevezető minden listához? Részletekért lásd Függőleges listák. Az idézetek megfelelően vannak-e attribútálva, és helyesen írtak-e? Minden idézet, összegzés, parafrázis megfelelően van-e hivatkozva APA, MLA vagy módosított IEEE stílus szerint? Részletekért lásd Idézetek és attribúciók. A szöveg mentes a nyelvtani, helyesírási és írásjelezési hibáktól? Részletekért lásd Gyakori nyelvtani, helyesírási problémák. Mentes a szóhalmozástól és más mondatstílusbeli hibáktól? Részletekért lásd Szóhalmozás és egyéb mondatstílus problémák. Az útmutató érthető-e a célközönség számára? Részletekért lásd Közönségelemzés és Technikai fordítás. És a felhasználói útmutató értékelésének befejezéséhez adjon egy számjegyet 100 és 55 között.

Kapcsolódó információ

Hogyan írjunk felhasználóbarát súgócímeket kezdőknek. clickhelp.com

Értékelem a gondolatait, visszajelzését és kritikáját e fejezettel kapcsolatban: az Ön válasza—David McMurrey.