Megjegyzés:
- Ez a fejezet, valamint a Műszaki ▒~Mrás teljes tankönyve, a műszaki írás készségeire összpp
ontosít.
- Az itt található műszaki tartalom sikeressége, pontossága vagy id▒~Qszerűsége nem garantált.
- Az oldalon található képekben lév▒~Q szöveg fordítása a lehet▒~Q leghamarabb elkészül.
- Kattintson ide, hogy segítsen David McMurrey webtárhelyének költségeit fedezni: Adományozzon bármii
lyen összeget! Az Online Technical Writing továbbra is ingyenes marad.
Kérjük, kattintson ide, hogy segítsen. Dávid McMurrey webtárhelyért fizetni:
Adományozz bármilyen kis összeget, amennyit csak tudsz.
Az online műszaki írás továbbra is ingyenes marad.
Ez az oldal javítás alatt áll.
A NotebookLLM által generált infografika erről a fejezetről
Átviteli üzenet
Utolsó bekezdés. Arra ösztönzi az olvasót, hogy lépjen kapcsolatba, ha kérdései, megjegyzései vagy aggályai vannak. Jóindulatú gesztussal zárul, kifejezve a reményt, hogy az olvasó elégedettnek találja a felhasználói útmutatót.
Ahogyan a felhasználói útmutató bármely más eleménél, előfordulhat, hogy módosítania kell ennek az üzenetnek (vagy feljegyzésnek) a tartalmát bizonyos helyzetekben. Például hozzáadhat egy további bekezdést, amelyben felsorolja azokat a kérdéseket, amelyeket szeretné, hogy az olvasók fontolóra vegyenek, amikor áttekintik a felhasználói útmutatót.
-->
Elülső és hátsó borítók
Címlap
Kiadási közlemény, Szerzői jogok, Védjegyek
Tartalomjegyzék
Előszó
Felhasználói útmutató főbb fejezetei
Mellékletek
Mellékletek
Tárgymutató
A felhasználói útmutató egyéb elemei
Címek
Felsorolások és számozott listák
Szimbólumok, számok és rövidítések
Grafikák és ábracímek
Kereszthivatkozások
Oldalszámozás
AI utasítások felhasználói útmutatókhoz
Az ellenőrző listák, amelyeket általában nem olvasnak el, némi módosítással felhasználhatók AI-promptok forrásaként. Másold ki a következőt, illeszd be egy mesterséges intelligencia rendszerbe, például a Google Gemini-be, és nézd meg, mit hagyhattál ki.
Megjegyzés: A felhasználói útmutatók tartalmára, formátumára vagy stílusára, illetve azok elemeire vonatkozó összes hivatkozás megtalálható a online műszaki szövegírási tankönyv.
Ha mesterséges intelligenciát szeretnél használni egy írásprojekt értékelésére, mutatkozz be, és mondd el az MI-nek, ki vagy és mit szeretnél. Adj az MI-nek egy viszonyítási pontot az értékeléshez, például egy online tankönyvet. Ezután írd le, mit szeretnél, hogy az MI ellenőrizzen az értékelés során.
Módosítsd a bevezetőt, hogy illeszkedjen az identitásodhoz.
|
Mesterséges intelligencia promptok — Felhasználói útmutatók
Helló, MI. Azt kérem, hogy értékeld egy amerikai főiskolai másodéves által írt utasításokat. Az alábbiakban tankönyvi fejezetek összefoglalója található a témáról utasítások és értesítések az értékelésének alapjául szolgáljon. (Azonosító információk maszkolva):
Tartalmazza a felhasználói útmutató a következőket (megfelelően formázva) ebben a sorrendben: átadási üzenet, első és hátsó borítók, címoldal; kiadási értesítés, tartalomjegyzék; előszó; fejezetek, függelékek (szükség szerint); tárgymutató, hátsó borító.
Noha lehet ötletes és játékos, vajon a felhasználói útmutató címe megfelelően jelzi-e a témáját? Részletekért lásd: Felhasználói útmutató címek.
Ha a tartalomjegyzék és az ábrák listája (illetve a táblázatok listája) pontvezetőket használ, az oldalszámok jobbra vannak rendezve? Ha a tartalomjegyzék és az ábrák listája (illetve a táblázatok listája) az oldal jobb szélén tünteti fel az oldalszámokat, használnak-e pontvezetőket? Részletekért lásd: Tartalomjegyzékek és ábra- és táblázatjegyzékek.
Jelzi-e a bevezető megfelelően a felhasználói útmutató témáját, célját és a célközönségét? Tartalmazza-e a lefedendő altémák listáját és jelzést a
hatókörre (mi nincs lefedve)? Részletekért lásd Bemutatkozások.
Tartalmazza‑e ez a felhasználói útmutató a megfelelő részleteket, konkrétumokat, példákat—mindent, ami szükséges az állítások és az általánosságok megmagyarázásához?
Figyelembe véve a témát, a célt és a célközönséget, hiányzik‑e bármilyen létfontosságú tartalom ebből a felhasználói útmutatóból? Vannak‑e felesleges tartalmak? Vannak‑e az útmutatóban olyan információk, amelyek műszakilag helytelenek? Hiányzik‑e bármilyen kritikus műszaki információ?
Tartalmaz-e ez a felhasználói útmutató bármilyen nyilvánvalóan átvett információt, amely egyáltalán nincs dokumentálva?
Előfordulnak-e a hivatkozások (az információforrás-listában szereplő tételekre való hivatkozások) a felhasználói útmutató szövegében az APA-, MLA- vagy módosított IEEE-stílus szerint formázva? Az információforrás-listában szereplő tételek APA-, MLA- vagy módosított IEEE-stílus szerint vannak-e formázva? Részletekhez lásd: Dokumentáció: kölcsönzött információforrások.
Az összes táblázat és nem dekoratív ábra tartalmaz-e leíró címet (feliratot) és forrást (ha szükséges)? Részletekért lásd: Táblázatcímek.
Mindegyik táblázat és nem díszítő ábra a vonatkozó szöveghez a lehető legközelebb található?
Vannak rövid, magyarázó kereszthivatkozások a táblázatok és a nem díszítő jellegű ábrák előtt? Részletekért lásd: Magyarázó kereszthivatkozások.
Használják a felhasználói útmutató törzsében a címsorok és alcímsorok szabványos formátumát? Részletekért lásd Címsorok.
A felhasználói útmutató fő részei (fejezetei) új oldalra kezdődnek a nyomtatott verziókban?
Használunk-e számozott, függőleges listákat olyan felsorolási elemekhez, amelyek meghatározott sorrendet igényelnek?
Használunk-e pontozott, függőleges listákat olyan felsorolási elemekhez, amelyeknek nincs kötelező sorrendje?
Használunk-e bevezető szövegeket minden lista előtt?
Részletekért lásd: Függőleges listák.
A közvetlen idézetek fel vannak-e tüntetve, és a feltüntetések helyes írásjelekkel vannak-e ellátva? Az összes közvetlen idézet, összefoglalás és parafrázis megfelelően hivatkozva van-e az APA-, MLA- vagy módosított IEEE-stílus szerint? Részletekért lásd: Idézetek és forrásmegjelölések.
A felhasználói kézikönyv szövege mentes‑e nyelvtani, szóhasználati és írásjelezési hibáktól? Részletekért lásd: Gyakori nyelvtani, nyelvhasználati és helyesírási problémák.
Mentes-e a felhasználói útmutató szövege a bőbeszédtől és más mondatstílusbeli hibáktól? Részletekért lásd: Terjengősség, egyéb mondatstílusbeli problémák.
Érthető-e ez a felhasználói útmutató a célközönség számára (ahogy azt a kísérőlevél és a bevezető jelzi)? Részletekért lásd: Közönségelemzés, és nézd meg A műszaki fordítás.
AT, hogy befejezze a felhasználói útmutatóm értékelését, adjon egy numerikus osztályzatot 100-tól 55-ig).
|
Kapcsolódó információk
Hogyan írjunk felhasználóbarát súgótémákat kezdőknek. clickhelp.com
Hogyan írjunk felhasználói dokumentációt. technikai író
Felhasználói útmutatók. technológiai író
Értékelném a gondolatait, reakcióit és kritikáját ezzel a fejezettel kapcsolatban:
a válaszod—David McMurrey.
