<

Kérjük, kattintson ide, hogy segítsen. Dávid McMurrey fizetni a webtárhelyért:
Adományozz bármilyen kis összeget, amennyit csak tudsz!
Az online műszaki írás továbbra is ingyenes marad.

Ez a fejezet bemutatja azokat a lazán meghatározott jelentéstípusokat, amelyek átgondolt véleményt vagy ajánlást adnak; ha pedig műszaki írási kurzuson veszel részt, te magad is megírsz egyet.

Mindenképpen nézd meg a mintajelentések.

Néhány finom különbség...

Megvalósíthatósági jelentések, ajánlási jelentések, értékelési jelentések, felmérési jelentések és ki tudja még mi minden mind nagyjából ugyanazt csinálják—alaposan megfontolt véleményeket és néha ajánlásokat adnak.

NotebookLM-generated infographic of this chapter A fejezet NotebookLM által generált infografikája

Tipikus tartalmak: Ajánlási és megvalósíthatósági jelentések

Bármilyen megvalósíthatósági, ajánlási vagy értékelési jelentést is ír, bárhogy is nevezik azt—a szakaszok többsége és ezeknek a szakaszoknak a felépítése nagyjából ugyanaz.

Az alapvető szerkezeti elv a következő: nemcsak az ajánlásodat, választásodat vagy ítéletedet adod meg, hanem az azt alátámasztó adatokat és a hozzá vezető következtetéseket is. Így az olvasók ellenőrizhetik a megállapításaidat, a logikádat és a következtetéseidet, és teljesen eltérő nézetre juthatnak.

Bevezetés. A bevezetésben jelezze, hogy a dokumentum célja a megvalósíthatóság meghatározása, javaslatok megfogalmazása vagy egy téma értékelése.

Műszaki háttér. Néhány ajánlási vagy megvalósíthatósági jelentéshez műszaki jellegű megbeszélésre lehet szükség ahhoz, hogy a jelentés többi része értelmes legyen. Az ilyen információval kapcsolatos dilemma az, hogy külön fejezetbe tegyük-e, vagy az összehasonlító szakaszokba illesszük-e, ahol releváns. Például a táblagépek teljesítményéről és sebességéről szóló vita megköveteli a RAM-ról, megahertzekről és processzorokról való némi megvitatást. Azt a részt egy olyan szakaszban kellene elhelyezni, amely a táblagépeket teljesítmény és sebesség szerint hasonlítja össze? Vagy tartsuk az összehasonlítást rendezettnek és tisztának, kizárólag az összehasonlításra és a következtetésre korlátozva? Talán az összes műszaki háttéranyagot egy külön fejezetben lehetne elhelyezni—vagy a jelentés elejére, vagy a mellékletbe.


Az ajánlási és megvalósíthatósági jelentések sémás vázlata. Ne feledje, hogy ez a tartalom és a szervezés tipikus vagy általános modellje.

A helyzet háttere. Sok ilyen jelentésnél szükséges megvitatni azt a problémát, igényt vagy lehetőséget, amely a jelentések elkészítését indokolta. Ha erről nincs sok mondanivaló, ez az információ a bevezetésben is elhelyezhető.

Követelmények és kritériumok. A megvalósíthatósági és ajánlási jelentések elengedhetetlen része azoknak a követelményeknek a tárgyalása, amelyeket a végső döntés vagy ajánlás meghozatalához fog használni. Íme néhány példa:

A követelményeket több alapvető módon lehet meghatározni:

A követelmények szakaszában arról is szó kell, hogy az egyes követelmények mennyire fontosak egymáshoz képest. Képzelje el a tipikus helyzetet, amikor egyik lehetőség sem a legjobb minden összehasonlítási kategóriában. Az egyik lehetőség olcsóbb; egy másik több funkcióval rendelkezik; egy harmadiknak jobb a használhatósági értékelése; egy negyedik pedig köztudottan tartósabb. Állítsa be a követelményeit úgy, hogy azok még olyan helyzetekben is "győztest" határozzanak meg, ahol nincs nyilvánvaló győztes.

Az opciók megvitatása. Bizonyos típusú megvalósíthatósági vagy ajánlási jelentésekben el kell magyaráznia, hogyan szűkítette le a választási lehetőségek körét azokra, amelyekre a jelentése összpontosít. Gyakran ez közvetlenül a követelményekről szóló vitát követi. Az alapvető követelményei valószínűleg maguk is leszűkítik a választási lehetőségek körét. De lehetnek egyéb szempontok is, amelyek kizárják a többi lehetőséget—magyarázza ezeket is.

Emellett előfordulhat, hogy rövid leírásokat kell adnia magukról az opciókról. Ne keverje össze ezt a következő szakaszban szereplő összehasonlítással. Ebben a leíró részben általános ismertetést nyújt az opciókról, hogy az olvasók némi tájékozottságot kapjanak róluk. A jelenlegi szintű tárgyalás nem összehasonlító jellegű; csupán általános tájékoztatás az opciókról. A táblagépes példában érdemes lehet rövid, általános műszaki adatokat megadni az egyes, összehasonlításra szánt modellekről.

Pontonkénti összehasonlítások. Egy megvalósíthatósági vagy ajánlási jelentés egyik legfontosabb része a lehetőségek összehasonlítása. Ne feledje, hogy ezt a részt azért tartalmazza, hogy az olvasók ellenőrizhessék az érvelését, és ha szeretnék, más következtetésekre juthassanak. Ezt összehasonlítási pontonként kell kezelni, nem lehetőségenként.


Sématikus ábra az egész–egész és a pontonkénti megközelítések összehasonlításának megszervezéséről. Hacsak nincs nagyon szokatlan témád, használd a pontról pontra haladó megközelítést.

Ha táblagépeket hasonlítanál össze, lenne egy rész, amely az áruk alapján hasonlítaná össze őket, egy másik rész, amely az akkumulátor üzemideje alapján hasonlítaná össze őket, és így tovább. Te nem lenne Legyen egy szakasz, amely az A lehetőséggel kapcsolatos összes dolgot tárgyalja, egy másik pedig a B lehetőséggel kapcsolatos összes dolgot, és így tovább. Ez egyáltalán nem lenne hatékony, mert az összehasonlításokat mégis valahol el kell végezni—valószínűleg a szerencsétlen olvasóra hárulna. (Lásd fent a két összehasonlítási megközelítés sématikus ábráját.)

Minden ilyen összehasonlító szakasznak a pontról pontra megközelítésnél úgy kell zárulnia, hogy egy következtetést tartalmazzon, amely megmondja, melyik opció a legjobb választás az adott összehasonlítási ponton. Természetesen nem mindig lesz könnyű egyértelmű győztest megnevezni—előfordulhat, hogy különféle módokon kell pontosítanod a következtetéseket, és többféle következtetést kell megfogalmaznod különböző feltételek esetén.

Megjegyzés: Mikor használnád valaha a teljes-összehasonlító megközelítést? Előfordulhat, hogy az összehasonlítások nem bonthatók logikusan pontokra—kategóriákra. Az összehasonlított lehetőségeknek különböző, egymással nem összehasonlítható előnyeik és hátrányaik lehetnek. Két összehasonlított termék eltérő, de átfedő funkciókészlettel rendelkezhet. Szóval melyiket részesíted előnyben—egy almát vagy egy narancsot?


Egyéni összehasonlító rész. Vegye észre, hogy ez a rész csak egy pontot hasonlít össze, és egyértelműen kimondott következtetéssel zárul arra az egy pontra vonatkozóan.

Ha értékelési jelentést készítenél, nyilvánvalóan nem a lehetőségeket hasonlítanád össze. Ehelyett a vizsgált dolgot az arra vonatkozó követelményekhez, az emberek vele szemben támasztott elvárásaihoz viszonyítanád. Például a Capital Metro-nak volt egy több mint egy évig tartó ingyenes buszközlekedési programja—. Mit vártak el attól a programtól? Teljesítette-e a program ezeket az elvárásokat?

Összefoglaló táblázat. Az egyes összehasonlítások után helyezzen el egy összefoglaló táblázatot, amely összegzi az összehasonlító szakasz következtetéseit. Néhány olvasó hajlamosabb arra, hogy a részletekre egy táblázatban figyeljen, mint a bekezdésekben. Ez nem mentesít a bekezdések megírása alól!


Összefoglaló táblázat. Egyes olvasók a táblázatos adatokat részesítik előnyben a bekezdésekben található adatokkal szemben.

Következtetések. A megvalósíthatósági vagy ajánlási jelentés következtetések szakasza részben összegzés vagy ismétlése azoknak a következtetéseknek, amelyeket már az összehasonlító részekben levont. Ebben a szakaszban ismételten megfogalmazza az egyes következtetéseket, például melyik modellnek volt a legjobb ára, melyiknek volt a legjobb akkumulátor-funkciója, és így tovább.

De ennek a szakasznak tovább kell haladnia. Fel kell oldania az összes ellentmondó következtetést, és valahogy el kell jutnia a végső következtetéshez, amely megállapítja, melyik a legjobb választás. Ezért a következtetés szakasz először felsorolja a fő következtetések—az egyszerű, egykategóriásakat. De akkor ki kell mondania másodlagos következtetések— amelyek kiegyensúlyozzák az ellentmondó elsődleges következtetéseket. Például, ha az egyik tablet a legolcsóbb, de rossz az akkumulátor üzemideje, míg egy másik a legdrágább és jó az akkumulátor üzemideje, melyiket választod, és miért? A másodlagos következtetés megadná a választ erre a dilemmára.

És természetesen a következtetések szakasza azzal zárul, hogy végső következtetés—az, amely meghatározza, melyik opció a legjobb választás.

Ajánlás vagy végső vélemény. A megvalósíthatósági és ajánlási jelentések záró része tartalmazza az ajánlást. Azt hinné az ember, hogy ennek már nyilvánvalónak kellene lennie. Általában így van, de ne feledd, hogy egyes olvasók rögtön az ajánlási részhez ugorhatnak, és megkerülhetik az összes kemény munkádat! Emellett lesznek olyan esetek is, amikor lehet, hogy van egy legjobb választás, de mégsem akarnád ajánlani. Korai időszakukban a laptopok nehezek és megbízhatatlanok—lehet, hogy volt egy modell, amely jobb volt a többi modellnél, de még megvásárolni sem érte meg.

A javaslati résznek vissza kell tükröznie a javaslathoz vezető legfontosabb következtetéseket, majd határozottan meg kell fogalmaznia maga a javaslatot. Általában előfordulhat, hogy különböző lehetőségek alapján több alternatívát kell ajánlania. Ezt, ahogy a példák is mutatják, felsorolásokkal (pontozott listákkal) lehet kezelni.


Elsődleges, másodlagos és végső következtetések. Észrevehető, hogy a 6. következtetésben két összehasonlítási kategóriát vetnek össze egymással, ahol a több lehetőség érvényesül az alacsonyabb költséggel szemben—egy másodlagos következtetés.

Egy értékelési jelentésben ez az utolsó rész egy végső véleményt vagy ítéletet tartalmazna. Íme néhány lehetőség:

Szervezeti tervek megvalósíthatósági és javaslati jelentésekhez

Most jó alkalom megvitatni ennek a jelentéstípusnak a két alapvető szervezési tervét:


Ugyanazon jelentés példavázlatai. Vegye észre, hogy a vezetői megközelítésnél az összes kulcsfontosságú tény, következtetés és ajánlás "elsőként" szerepel, így az olvasó gyorsan hozzájuk fér. Nagyobb jelentésekben minden melléklethez külön fül tartozik.

AI-promptok ajánlási jelentésekhez

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á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: Az adatjelentések tartalmára, formátumára, stílusára vagy azok összetevőire vonatkozó összes hivatkozás megtalálható a online műszaki írás tankönyv.

Amikor AI-t szeretnél használni egy írási projekt értékelésére, mutatkozz be, mondd el az AI-nak, ki vagy és mit szeretnél. Adj az AI-nak egy kiindulópontot az értékeléshez, például egy online tankönyvet. Ezután tedd közzé, hogy mit szeretnél, hogy az AI ellenőrizzen az értékelésében.

Módosítsd a bevezetőt, hogy illeszkedjen az identitásodhoz.

AI-promptok ajánlási jelentésekhez

Helló, MI. David McMurrey vagyok, az Austin Community College (Austin, Texas) kiberbiztonsági hallgatója. Kérem, értékelje a következő ajánlási jelentést ezzel online tankönyv, a fejezet ...ről ajánlási jelentések, és a következő kérdések:

  1. Bár lehet találékony és játékos, vajon ennek a javaslati jelentésnek a címe megfelelően jelzi-e a tárgyát? Részletekért lásd: Műszaki dokumentáció címek.
  2. A bevezető megfelelően jelzi-e a javaslati jelentés témáját, célját és a célzott közönséget? Tartalmazza-e a bevezető a tárgyalandó alfejezetek listáját, és jelzi-e a terjedelem határait (mi nincs lefedve)? A részletekért lásd: Bemutatkozások.
  3. Tartalmaz-e ez az ajánlási jelentés szakaszokat: műszaki háttér (ha szükséges), a helyzet háttere (ha azt a bevezetés nem tárgyalja), követelmények, a lehetőségek megvitatása, összegző táblázat, a következtetések listája, ajánlás, információforrások?
  4. Tartalmazza a következtetések listája az elsődleges következtetéseket, a másodlagos következtetéseket és a végső következtetést?

  5. Tartalmaz-e ez az ajánlási jelentés elegendő részletet, konkrétumot, példákat—akármit, ami szükséges az állítások és az általános megállapítások alátámasztásához?
  6. Figyelembe véve a témát, a célt és a közönséget, hiányzik-e bármilyen alapvető tartalom ebből az ajánlási jelentésből? Vannak-e benne felesleges tartalmak? Található-e a jelentésben olyan információ, amely technikailag helytelen? Hiányzik-e bármilyen kritikus műszaki információ?
  7. Tartalmaz-e ez az ajánlási jelentés olyan nyilvánvalóan átvett információt, amelyet semmilyen módon nem dokumentáltak?
  8. Az idézetek (az információforrás-listában szereplő tételekre való hivatkozások) ennek az ajánlási jelentésnek a szövegében az APA-, MLA- vagy a módosított IEEE-stílus szerint vannak-e formázva? Az információforrás-listában szereplő tételek az APA-, MLA- vagy a módosított IEEE-stílus szerint vannak-e formázva? Részletekért lásd: Dokumentáció: kölcsönzött információforrások.
  9. Tartalmaznak‑e az összes táblázat és nem díszítő jellegű ábra leíró címet (feliratot) és forrást (ha szükséges)? Részletekért lásd: Táblázatcímek.
  10. Az összes táblázat és nem díszítő jellegű ábra a lehető legközelebb helyezkedik el a hozzájuk tartozó szöveghez?
  11. Megjelennek 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.
  12. Használják-e a javaslati jelentés törzsében a címsorok és alcímsorok szabványos formátumát? Részletekért lásd: Címsorok.
  13. Használunk számozott, függőleges listákat a kötelező sorrendben szereplő listaelemekhez? Használunk felsorolásjelekkel ellátott, függőleges listákat a nem kötelező sorrendű listaelemekhez? Használunk bevezető szöveget minden lista előtt? Részletekért lásd: Függőleges listák.
  14. A közvetlen idézetek meg vannak-e jelölve, és a megjelölések helyesen vannak-e írásjelekkel ellátva? Minden közvetlen idézet, összefoglalás és parafrázis megfelelően van-e hivatkozva az APA-, az MLA- vagy a módosított IEEE-stílus szerint? Részletekért lásd: Idézetek és hivatkozások.
  15. Mentes‑e ennek a javaslati jelentésnek a szövege nyelvtani, nyelvhasználati és írásjel‑használati hibáktól? A részletekért lásd: Gyakori nyelvtani, szóhasználati és helyesírási problémák.
  16. Mentes a javaslati jelentés szövege a bőbeszédűségtől és más mondatstílusbeli hibáktól? Részletekért lásd: Szószaporítás, egyéb mondatstílusbeli problémák.
  17. Érthető-e ez az ajánlási jelentés a célközönsége számára (ahogyan azt a bevezető jelzi)? Részletekért lásd Közönség-elemzés, és nézd meg A műszaki szöveg fordítása.
  18. MI, hogy befejezd az ajánlási jelentésem értékelését, adj egy numerikus pontszámot 100-tól 55-ig).

Kapcsolódó információk

Online műszaki írás tankönyv

Ajánlási jelentések

Értékelném a gondolatait, reakcióit és kritikáját ezzel a fejezettel kapcsolatban: a válaszodDavid McMurrey.