Megjegyzés:
  • Ez a fejezet, valamint a Műszaki Írás teljes tankönyve, a műszaki írás készségeire összpontosít.
  • Az itt található műszaki tartalom sikeressége, pontossága vagy időszerűsége nem garantált.
  • Az oldalon található képekben lévő szöveg fordítása a lehető leghamarabb elkészül.
  • Kattintson ide, hogy segítsen David McMurrey webtárhelyének költségeit fedezni: Adományozzon bármilyen összeget! Az Online Technical Writing továbbra is ingyenes marad.

Kérjük, kattintson ide, hogy segítsen David McMurrey webtárhely-költségeinek fedezésében:
Adományozzon bármilyen kis összeget, amennyit csak tud!
Az Online Technical Writing továbbra is ingyenes marad.


Egy adatjelentés (data report) itt olyan jelentést jelent, amely nagy mennyiségű adatot tartalmaz táblázatok, chartok és grafikonok formájában. A technikai író (technical writer):

  1. olyan forrással kezdi a munkát, amely többnyire táblázatokat tartalmaz.
  2. olyan chartokat és grafikonokat készít, amelyek szemléletesebben ábrázolják a táblázatokban szereplő adatokat.
  3. explanatory cross-references elemeket ad hozzá, hogy megfogalmazza a táblázatos adatok kulcsfontosságú trendjeit és következtetéseit.

A technikai író munkájának eredménye egy olyan adatjelentés, amelyet sokkal könnyebb gyorsan átfutni (skim), és amelyből egyszerűbb kiemelni a lényeges pontokat.

Az adatjelentéseket minden iparágban és a kormányzat minden ágában használják:

Feltétlenül tekintse meg a példákat.

A fejezethez készült, NotebookLM által generált infografika A fejezethez készült, NotebookLM által generált infografika

Egy adatjelentés felépítése

Az emberekhez hasonlóan az adatjelentések is sokféle formában és méretben léteznek. Itt egy olyan keretrendszer látható, amelyet változtatás nélkül használhat, vagy igény szerint módosíthat.

Ha adatjelentést készít, lásd: Create Data Report

heading
table
chart
explanatory cross-reference
source indicator

Ebben a példában figyelje meg egy adatjelentés egyetlen szakaszának felépítését: táblázat (kihagyva), grafikon, explanatory cross-reference:

Adatjelentés-grafikon táblázat vagy cross-reference magyarázat nélkül

Amint a 4. ábrán látható, az előállított papíralapú anyagok mennyisége meghaladta az újrahasznosított papíralapú anyagokét—6730 millió tonna szemben 4760 millió tonnával—az 1960 és 2015 közötti időszakban.

Íme egy további példa egy explanatory cross-reference elemre:

Az MSW keletkezésének és visszanyerésének trendjeit bemutató grafikon

6. ábra. MSW font/fő/nap

Amint a fenti ábrán látható, a települési szilárd hulladék (municipal solid waste, MSW) visszanyerésében elért előrehaladás 2000-ig növekedett, majd azt követően megtorpant.

AI Prompts adatjelentésekhez

Az ellenőrzőlisták, amelyeket általában nem olvasnak el, némi módosítással felhasználhatók AI prompts forrásaként. Másolja ki az alábbiakat, illessze be egy AI-rendszerbe, például a Google Gemini-be, és nézze meg, mit hagyhatott ki.

Megjegyzés: Az adatjelentések tartalmára, formátumára és stílusára, illetve azok összetevőire vonatkozó összes hivatkozás megtalálható az online technical-writing textbook oldalán.

AI Prompts adatjelentésekhez

  1. Tartalmazza-e az adatjelentés legalább az alábbi elemeket (megfelelően formázva) és ebben a sorrendben: tartalomjegyzék (table of contents); ábrák, táblázatok vagy ezek kombinált listája; bevezetés; törzsszakaszok (fejezetek); információforrások? Részletekért lásd: Techdoc design.
  2. Bár lehet ötletes és játékos, a data report címe megfelelően jelzi-e a tárgyát? Részletekért lásd: Techdoc titles.
  3. Ha a tartalomjegyzék és az ábrák (és táblázatok) listája vezetőpontokat (leader dots) használ, a lapszámok jobbra igazítottak-e? Ha a tartalomjegyzék és az ábrák (és táblázatok) listája a lap jobb szélén tünteti fel a lapszámokat, használnak-e leader dots elemeket? Részletekért lásd: TOCs and List of Figures (Tables).
  4. A bevezetés megfelelően jelzi-e a techdoc témáját, célját és célközönségét? Tartalmaz-e a tárgyalandó altémák felsorolását, valamint a terjedelem megjelölését (mi nem része az anyagnak)? Részletekért lásd: Introductions.
  5. Megjelennek-e az idézések (az információforrások listájában szereplő elemekre való hivatkozások) a techdoc törzsszövegében, APA, MLA vagy módosított IEEE stílus szerint formázva? Az információforrások listájában szereplő elemek APA, MLA vagy módosított IEEE stílus szerint vannak-e formázva? Részletekért lásd: Documentation: borrowed information sources.
  6. Az adatjelentés minden törzsszakasza egy azonosító jellegű címsorral (heading) kezdődik-e? Részletekért lásd: Headings.
  7. Az adatjelentés minden törzsszakasza tartalmaz-e egy táblázatot, az adott táblázatot szemléltető chartot, valamint egy explanatory cross-reference bekezdést (bármilyen sorrendben)? Részletekért lásd: Tables; Tables and Charts in Microsoft; Tables and Charts in Google Sheets.
  8. Logikusak-e az adatjelentésben szereplő chartok? Például a line chart kizárólag időrendi (chronological) adatokhoz van-e használva?
  9. Tartalmaz-e az adatjelentés legalább egy oszlop- vagy sávdiagramot (bar vagy column chart), egy kördiagramot (pie chart) és egy vonaldiagramot (line chart)?
  10. Az explanatory cross-reference bekezdések hivatkoznak-e legalább egy fontos tényre vagy trendre, amely a táblázatban és a chartban szerepel?
  11. Minden táblázat és chart rendelkezik-e leíró címmel (caption) és forrásmegjelöléssel (szükség esetén)? Részletekért lásd: Table titles.
  12. Minden táblázat és nem dekoratív ábra a hozzá tartozó szöveghez a lehető legközelebb helyezkedik-e el?
  13. Az adatjelentés szövege mentes-e nyelvtani, szóhasználati (usage) és írásjel-használati (punctuation) hibáktól? Részletekért lásd: Common Grammar, Usage, Spelling Problems.
  14. Az adatjelentés szövege mentes-e a fölösleges bőbeszédűségtől (wordiness) és más mondatstílusbeli hibáktól? Részletekért lásd: Wordiness, other sentence-style problems.
  15. A techdoc érthető-e a célközönség számára (ahogyan azt az átkísérő üzenet (transmittal message) és a bevezetés jelzi)? Részletekért lásd: Audience analysis, valamint Translating the Technical.
  16. Tartalmaz-e az adatjelentés más forrásokból szó szerint idézett, átfogalmazott (paraphrased) vagy összefoglalt szöveget dokumentálás nélkül, ami plagiarism jelenlétére utal? Részletekért lásd: Plagiarism. Purdue OWL.
  17. Az előző értékelések figyelembevételével:
    • Mi a jó ebben az adatjelentésben?
    • Mi az, ami kevésbé jó ebben az adatjelentésben?
  18. Milyen numerikus osztályzat (100 pontos skálán) adható ennek az adatjelentésnek a fenti értékelő kérdések alapján?

Megjegyzés: Az adatjelentések vagy azok összetevőinek tartalmára, formátumára és stílusára vonatkozó valamennyi hivatkozás megtalálható az online technical-writing textbook oldalán.

Örömmel fogadom gondolatait, reakcióit és kritikáit e fejezettel kapcsolatban: válasza—David McMurrey.