Kérlek, kattints 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.
A technikai dokumentumok (beleértve a kézikönyveket, fehér könyveket és útmutatókat) különböző tervezési formákkal rendelkeznek, az iparágtól, a szakmától vagy a szervezettől függően. Ez a fejezet egy hagyományos tervezést mutat be. Ha technikai írást tanul, győződjön meg róla, hogy a fejezetben bemutatott tervezés elfogadható. Ugyanez érvényes, ha tudományos, üzleti vagy kormányzati környezetben ír technikai dokumentumot.
A NotebookLM által generált infografika erről a fejezetről
Megjegyzés: Évek óta ez az online műszaki írás tankönyv a jelentéseket gyakorlatilag bárminek nevezte, ami műszaki információt tartalmaz. De mivel a "jelentés" egy specifikus műszaki dokumentum műfajára utal, változtatást kellett eszközölni a generikus "techdoc" kifejezésre, ami a műszaki dokumentum rövidítése.
A techdocok (általános név a műszaki dokumentumokra) specifikációkkal rendelkeznek, akárcsak bármilyen más projekttípussal. A techdocok specifikációi magukban foglalják a layoutot, a szervezést és a tartalmat, a címek és listák formátumát, a grafikák tervezését és így tovább. A kötelező szerkezet és formátum előnye a techdocok esetében, hogy Ön vagy bárki más elvárhatja, hogy ismerős módon legyenek megtervezve—tudja, mit keressen és hol keresse. A techdocokat általában sietve olvassák—az emberek sietnek, hogy eljussanak a szükséges információkhoz, a lényeges tényekhez, a következtetésekhez és más alapvető dolgokhoz. Egy szabványos techdoc formátum olyan, mint egy ismerős szomszédság.
Amikor egy technikai dokumentum tervezését elemzed, vedd észre, mennyire repetitív egyes szekciók. Ez a duplikáció kapcsolódik ahhoz, ahogyan az emberek olvassák a technikai dokumentumokat. Az emberek nem olvassák végig a technikai dokumentumokat: lehet, hogy a végrehajtói összefoglalóval kezdik, átugranak szakaszokat, és valószínűleg nem olvassák el az összes oldalt. A kihívásod az, hogy úgy tervezd meg a technikai dokumentumokat, hogy ezek az olvasók találkozzanak a kulcsfontosságú tényekkel és következtetésekkel, függetlenül attól, hogy mennyit olvasnak a dokumentumból, vagy milyen sorrendben olvassák azt.
Győződj meg róla, hogy megnézed a példa technikai dokumentációk.
A tipikus műszaki jelentés standard komponenseit ebben a fejezetben tárgyaljuk. A következő szakaszok átvezetnek ezek mindegyikén, kiemelve a kulcsfontosságú jellemzőket. Amint olvasod és használod ezeket az irányelveket, ne feledd, hogy ezek irányelvek, nem parancsok. Különböző cégeknek, szakmáknek és szervezeteknek saját változatos irányelveik vannak a technikai dokumentumokhoz, ezért igazítanod kell a gyakorlatodat ezekhez, valamint az itt bemutatottakhoz.
Átadási Üzenet
A továbbító üzenet lehet egy kísérőlevél (vagy emlékeztető) vagy egy e-mail. A fizikai levél (vagy emlékeztető) vagy a technikai dokumentum külső részéhez van rögzítve egy gemkapoccsal, vagy a technikai dokumentumban van összefűzve. Az e-mail tartalmaz egy linket a technikai dokumentumhoz, vagy a technikai dokumentumot csatolja. Ez egy kommunikáció tőled—a technikai dokumentum írójától—a címzett felé, aki kérte a technikai dokumentumot, és aki talán még fizet is neked a szakértői tanácsadásodért. Lényegében azt mondja: "Rendben, itt van a technikai dokumentum, amelyet megbeszéltünk, hogy ilyen-olyan időpontig elkészítem. Röviden tartalmazza ezt és azt, de nem foglalkozik ezzel vagy azzal. Kérlek, tudasd velem, hogy megfelel-e az igényeidnek." A továbbító üzenet magyarázza a kontextust—azokat az eseményeket, amelyek a technikai dokumentum létrejöttéhez vezettek. Információkat tartalmaz a technikai dokumentumról, amelyek nem tartoznak bele a technikai dokumentumba.
A transzmittálási levél és egy transzmittálási üzenet példái.
A továbbítási levél példájában figyelje meg a standard üzleti levél formátumot. Ha egy belső technikai dokumentumot ír, inkább a memorandum formátumot használja; bármelyik esetben a tartalom és a szerkezet ugyanaz:
Első bekezdés. Hivatkozik a technikai dokumentum nevére, dőlt betűvel írva. Szintén megemlíti a technikai dokumentum megírásáról szóló megállapodás dátumát.
Középső bekezdés. Fókuszál a techdoc céljára, és rövid áttekintést ad a techdoc tartalmáról.
Utolsó bekezdés. Ösztönzi az olvasót, hogy lépjen kapcsolatba, ha kérdései, megjegyzései vagy aggályai vannak. Jó kívánsággal zár, kifejezve a reményét, hogy az olvasó elégedett lesz a techdokkal.
Ahogy bármely más elemet egy technikai dokumentumban, előfordulhat, hogy módosítanod kell ennek az üzenetnek (vagy emlékeztetőnek) a tartalmát a konkrét helyzetekhez. Például lehet, hogy szeretnél hozzáadni egy új bekezdést, amelyben felsorolod azokat a kérdéseket, amelyeket szeretnél, hogy az olvasók figyelembe vegyenek a technikai dokumentum átnézésekor.
Borítók, Címlap és Címke
Ha a techdokumentációd több mint tíz oldal, kössd össze valahogy, és készíts egy címkét a borítóra.
Borítók
A borítók szilárd, professzionális megjelenést kölcsönöznek a technikai dokumentációknak, valamint védelmet nyújtanak. Sokféle borító közül választhatsz. Tartsd észben ezeket a tippeket:
- Teljesen elfogadhatatlanok a világos (vagy színes) műanyag tokok, amelyek bal széle műanyag huzattal van ellátva. Ezek olyanok, mint valami az elsőéves angol óráról; ráadásul nehezen használhatóak—az olvasóknak küzdeniük kell azért, hogy nyitva tartsák őket, és bajlódniuk kell a statikus elektromossággal, amit generálnak.
- Marginalisan elfogadhatóak azok a borítók, amelyeknél lyukat fúrunk a lapokba, betesszük a lapokat, és lehajtjuk a kék kávékat. Ha ezt a típust használod, hagyj egy extra fél hüvelyk margót a bal szélen, hogy az olvasók ne kénytelenek legyenek feszíteni a lapokat. Természetesen ez a borítótípus megakadályozza, hogy a lapok vízszintesen feküdjenek: az olvasóknak elérhető tárgyakat kell megragadniuk, vagy különböző testrészeiket kell használniuk, hogy a lapokat lenyomva tartsák.
- A legjobb borítók egyértelműen azok, amelyek lehetővé teszik, hogy a technikai dokumentumok maguktól kinyitva feküdjenek (lásd a következő szakaszban található illusztrációt). Micsoda nagy megkönnyebbülés, ha egy technikai dokumentum az öledben vagy az íróasztalodon hever. Ez a típus műanyag spirált használ a kötéshez és vastag, kartonpapírból készült borítót. Ellenőrizze a helyi másolóüzletét ezekkel a kötési típusokkal kapcsolatban; megfizethetőek és növelik munkája professzionális megjelenését. Lásd a következő műanyag spirálkötés szimulált példáját.
Általánosságban véve a laza lapú jegyzetfüzetek vagy a gyűrűs mappák kevésbé preferáltak. Ezek túl bulkyak a rövid technikai dokumentumokhoz, és a lapoklyukak hajlamosak elszakadni. Természetesen, a gyűrűs mappa megkönnyíti a lapok cseréjét; ha így fogják használni a technikai dokumentumodat, akkor jó választás. A "magas végén" a túlságosan díszes borítók találhatók, amelyek műbőr kinézetűek és aranyszínű díszítéssel rendelkeznek. Kerüld el őket—tartsd egyszerűnek, letisztultnak és funkcionálisnak.
Címoldal
A legegyszerűbb formájában a techdoc cím a borítón lévő szöveg másolata—esetleg néhány részlettel kiegészítve.
Nézd meg a címoldalt. Összefoglaló és Vezetői Összefoglaló.
Címkék
Ne felejts el címkét készíteni a technikai dokumentációd borítójához. Ez egy lépés, amit néhány technikai dokumentáció írója elfelejt. Címke nélkül a technikai dokumentáció névtelen; figyelmen kívül hagyják.
A címke legjobb készítési módja, ha a szövegszerkesztő szoftveredet használod, hogy egy szabványos oldalon megtervezd, grafikus keretet körülötte a címke információval. Nyomtasd ki, majd menj egy fénymásoló üzletbe, és másoltasd közvetlenül a technikai dokumentum borítójára.
Nem sok minden kerül a címkére: a technikai dokumentum címe, a neved, a szervezeted neve, a technikai dokumentum nyomonkövetési száma és egy dátum. Nincsenek standard követelmények a címkére, bár a cégednek vagy szervezetednek saját követelményei lehetnek. (A technikai dokumentum címkéjének példája lent látható.)
Küldeménylevél és műszaki dokumentáció borító (borítócímkével).
Összefoglaló és Vezetői Összegzés
A legtöbb technikai techdokumentum legalább egy absztraktot tartalmaz—néha kettőt, és ilyenkor az absztraktok különböző szerepeket töltenek be. Az absztraktok összefoglalják a techdokumentum tartalmát, de a különböző típusok ezt más módon teszik:
- Leíró absztrakt. Ez a típus áttekintést nyújt a technikai dokumentum céljáról és tartalmáról. Néhány technikai dokumentum tervezésében a leíró összefoglaló a címoldal alján található, ahogy az alábbiakban látható:
Leíró összefoglaló. Hagyományosan a címoldalon helyezkedik el (nem a borítóoldalon). - Vezetői összefoglaló. Egy másik általános típus az ügyvezető összefoglaló, amely szintén összefoglalja a technikai dokumentumban található kulcsfontosságú tényeket és következtetéseket. Lásd az alábbi példát. Olyan, mintha sárga filctollal kiemelted volna a kulcsmondatokat a technikai dokumentumban, majd mindet áttelepítetted volna egy külön oldalra, és olvashatóság érdekében szerkesztetted volna. Általában az ügyvezető összefoglalók a teknikai dokumentumok egytizedétől egyhúszadáig terjednek, melyek hossza tíztől ötven oldalig terjed. Hosszabb technikai dokumentumok esetén, amelyek meghaladják az ötven oldalt, az ügyvezető összefoglalónak nem szabad két oldalt túllépnie. Az ügyvezető összefoglaló célja, hogy összefoglalja a technikai dokumentumot – olyan információt nyújtva, amelyet gyorsan el lehet olvasni.
Ha a végrehajtói összefoglaló, a bevezetés és az átküldő üzenet ismétlődőnek tűnik, ne feledd, hogy az olvasók nem feltétlenül az elejétől kezdve olvassák végig a technikai dokumentációt. Átlapoznak: lehet, hogy megvizsgálják a tartalomjegyzéket; általában átfutják a végrehajtói összefoglalót a kulcsfontosságú tények és következtetések miatt. Lehet, hogy csak egy vagy két szakaszt olvasnak el figyelmesen a dokumentum törzséből, majd átugorják a többit. Ezek miatt a technikai dokumentációkat úgy tervezik, hogy némi ismétléssel biztosítsák, hogy az olvasók mindenhol lássák a fontos információkat, függetlenül attól, hol merülnek el a dokumentumban.
Tartalomjegyzék (ami először jön) majd a végrehajtási összefoglaló.
Tartalomjegyzék
Bármelyik tartalomjegyzék (TOC) formát használod, ezek a közös szabványok:
- Csak a kezdőoldal száma. Bár néhány automatikus tartalomjegyzék-generátor megjeleníti az oldalszám-tartományt, a szabvány csak az első oldalszámot mutatja.
- A címsorok szintje, amelyeket be kell vonni. Ahogy a fenti TOC-n látható, a legfelső két szintű címet kell megjeleníteni, hacsak a techdokumnak nincsen sok alsó címe. A TOC-nak egy gyors információkeresési módot kell biztosítania.
- Köztes tér és nagybetűk. Észre fogja venni, hogy a fenti tartalomjegyzék szövegelemei behúzottak. Az első szintű címek nagybetűsek; a második szintű címek minden fő szónál nagy kezdőbetűt használnak; a harmadik szintű címek mondatszerű nagybetűs írást alkalmaznak.
- Függőleges térköz. Vegye észre, hogy az első szintű szakaszok fölött és alatt extra hely van, ami növeli az olvashatóságot.
- A techdoc összes oldalát (a front és hátsó borítókat nem számítva) számozzák; de néhány oldalon a számok nincsenek feltüntetve.
- A kortárs tervezésben a dokumentum összes oldalán arab számokat használnak; a hagyományos tervezésben pedig az összes oldal, amely az előszót megelőzi (a szöveg első oldala), kisbetűs római számokat használ.
- Különleges oldalakon, mint a címoldal és az bevezető első oldala, az oldalszámok nincsenek feltüntetve.
- A oldalszámok elhelyezhetők az oldal több helyszínén is. Általában a legjobb és legegyszerűbb választás, ha az oldalszámokat az oldal alján, középen helyezzük el (ne felejtsük el, hogy különleges oldalakon el kell rejteni őket).
- Ha az oldalszámokat az oldal tetején helyezi el, el kell rejtenie őket a fejezet- vagy szakasznyitókon, ahol a fejezetcím vagy cím az oldal tetején van.
- Tartalmazza a techdoc (jelentés) a következőket (megfelelő formázásban) ebben a sorrendben: átviteli üzenet; címoldal; tartalomjegyzék; ábrák, táblázatok vagy mindkettő listája; bevezetés; főbb szakaszok (fejezetek); mellékletek (szükség szerint); információforrások; hátsó borító (ha szükséges). Részletekért lásd Techdoc tervezés.
- Bár lehet okos és játékos, megfelelően jelzi a technikai dokumentum címe a téma lényegét? Részletekért lásd Techdoc címek.
- Ha a tartalomjegyzék és a képek (valamint a táblázatok) listája vezetőpontokat használ, a page számok jobbra igazítottak? Ha a tartalomjegyzék és a képek (valamint a táblázatok) listája tartalmazza a page számokat a lap jobb szélén, vezetőpontokat használnak? Részletekért lásd Tartalomjegyzék és Ábrák (Táblázatok) спискe.
- Megfelelően jelzi a bevezetés a téma, a cél és a technikai dokumentáció célközönségét? Tartalmaz egy listát a feldolgozandó alakérdésekről és egy jelzést a terjedelméről (mi nincs lefedve)? Részletekért lásd Bevezetők.
- Tartalmaz ez a technikai dokumentum elegendő részletet, specifikációt, példákat, hogy megmagyarázza az állításokat, az általánosságokat?
- Figyelembe véve a témát, a célt és a közönséget, hiányzik valamilyen lényeges tartalom ebből a technikai dokumentumból? Van-e olyan tartalom, ami szükségtelen? Van-e bármilyen információ, amely technikailag hibás ebben a technikai dokumentumban? Hiányzik-e bármilyen kritikus műszaki információ?
- Ebben a technikai dokumentumban található-e bármilyen nyilvánvalóan átvett információ, amely nincs dokumentálva?
- A hivatkozások (az információforrások listájára való hivatkozások) megjelennek a technikai dokumentumban, az APA, MLA vagy módosított IEEE stílus szerint? Az információforrások listáján lévő elemek az APA, MLA vagy módosított IEEE stílus szerint vannak formázva? További részletekért lásd Dokumentáció: kölcsönzött információs források.
- Minden táblázatnak és nem dekoratív ábrának tartalmaznia kell egy leíró címet (feliratot) és forrást (ha szükséges)? A részletekért lásd Táblázat címek.
- Minden táblázatnak és dekoráció nélküli ábrának a lehető legközelebb kell lennie a megfelelő szöveghez?
- Történik rövid, magyarázó keresztutalás a táblák és nem dekoratív ábrák előtt? Részletekért lásd Magyarázó kereszt-vonatkozások.
- Használva van-e egy standard formátum a főcímek és alcímek számára a technikai dokumentum szövegében? Részletekért lásd Címek.
- A technikai dokumentum fő részei (fejezetek) új oldallal kezdődnek a nyomtatott változatokban?
- A számozott függőleges listákat a kötelező sorrendű listaelemekhez használják? A felsorolásos függőleges listákat a nem kötelező sorrendű listaelemekhez használják? Használunk bevezetőket minden lista előtt? További részletekért lásd Függőleges listák.
- A közvetlen idézetek a megfelelően vannak-e tulajdonítva, és a hivatkozások helyesen vannak-e írásjelezve? Minden közvetlen idézet, összefoglalás, parafrázis megfelelően van-e hivatkozva APA, MLA vagy módosított IEEE stílus szerint? További részletekért lásd Idézetek és hivatkozások.
- A techdoc szövege mentes a nyelvtani, használati és írásjelezési hibáktól? Részletekért lásd Gyakori nyelvtani, használati, írásban előforduló problémák.
- A techdoc szövege mentes a szószátyárságtól és egyéb mondatszerkezeti hibáktól? További részletekért lásd Szóhalmozás, egyéb mondatstílusbeli problémák.
- Ez a műszaki dokumentum érthető a célközönsége számára (ahogy azt az átadó üzenet és az bevezetés jelezte)? Részletekért lásd Közönség elemzés, és nézd A technikai fordítás.
- AI, hogy befejezhesd a technikai dokumentációm értékelését, adj egy numerikus osztályzatot 100-tól 55-ig.
Vezető pontok és jobbra igazított oldalszámok. A hagyományos tartalomjegyzékhez, amely vezető pontokat használ és jobbra igazított oldalszámokat tartalmaz:
Jobbra igazítás. Ebben a példában, vegye észre, hogy a vezető pontok "kihúzzák" a jobbra igazított oldalszámokat.
Vezető pontok és jobbra zárt oldalszámok.
Ez a tartalomjegyzék tizedes számformát használ a fejezetek és szakaszok számozásához, ami a technikai dokumentációkban gyakori. A könyv többi része csak a legfelső szintű fejezetekhez használja a nagybetűs római számformát (lásd).
Problémáid vannak egy jól formázott tartalomjegyzék elkészítésével? Lásd Hozzon létre egy professzionálisan kinéző tartalomjegyzéket
Vesszők és oldalszámok. Ha a vezető-pont formátumra nincs szükség, és szeretnéd elkerülni, használhatod ezt a gyakran elfogadott formátumot:
|
3. AZ ENERGIAHATÉKONYSÁG KULCSFONTOSSÁGÚ ELVEI, 5
Passzív Tervezési Stratégiák, 6
4. SZABVÁNYOK ÉS TANÚSÍTVÁNYOK, 11Aktív Energiarendszerek, 7 Megújuló Energia Integráció, 9
LEED, 11
Energia Csillag, 12 Élő Épület Kihívás, 14 |
Ábrák és táblázatok listája
A képek listája számos ugyanazon tervezési megfontolást tartalmaz, mint a tartalomjegyzék. Az olvasók a képek listáját használják, hogy megtalálják az illusztrációkat, diagramokat, táblázatokat és grafikonokat a műszaki dokumentációdban.
Bonyodalmak merülnek fel, ha egyszerre van jelen táblázat és ábra. Szigorúan véve az ábrák illusztrációk, rajzok, fényképek, grafikonok és diagramok. A táblázatok szavak és számok sorai és oszlopai; nem tekinthetők ábráknak.
Hosszabb technikai dokumentumok esetén, amelyek tucatnyi ábrát és táblázatot tartalmaznak, készíts külön listákat az ábráknak és a táblázatoknak. Helyezd el őket ugyanazon az oldalon, ha elférnek, mint az alábbi illusztráción. Ötvözheted a két listát az "Ábrák és táblázatok listája" címmel, és az elemeket az ábra vagy táblázat megjelölésével az alábbi illusztráció szerint azonosíthatod.
Bevezetés
A techdokumentum alapvető eleme a bevezetés—biztosítsd, hogy tisztában legyél annak valódi céljával és tartalmával. A techdokumentumban a bevezetés felkészíti az olvasót a techdokumentum fő részének elolvasására. Lásd bevezetők az bevezetők írásáról folytatott diskurzushoz.
Nézd meg ezt a példát egy bevezetésre:
A táblázatok és ábrák listája, amelyet az bevezetés követ.
Ha nincsenek táblázatok, akkor írja "Ábrák listája." Egy műszaki írás kurzusban kérdezze meg az oktatóját, hogy szükséges-e a fejlécek tizedes számú számozási stílusa.
A Techdoc törzse
A technikai dokumentum törzse természetesen a technikai dokumentum fő szövege, az egyes szakaszok a bevezetés és a következtetés között. Az alábbiakban mintapéldák láthatók.
Címek
Minden, a legrövidebb technikai dokumentumokon (két oldal vagy kevesebb) használj fejezetcímeket a különböző témák és alcímek megjelölésére. A fejezetcímek lehetővé teszik az olvasók számára, hogy átfussanak a technikai dokumentumodon, és mélyebben belemerüljenek azokba a részekbe, ahol olyan információt adsz elő, amire szükségük van. címek útmutató a címsorokról.
Felsorolások és Számozott Listák
A techdoc törzsében használjon fel megfelelően felsorolt, számozott és kéthasábos listákat is. A listák segítenek a kulcsfontosságú pontok kiemelésében, az információk könnyebb követésében, és a szöveg tömörségének csökkentésében. Lásd listák útmutatók listákhoz.
Szimbólumok, számok és rövidítések
A technikai megbeszélések általában sok szimbólumot, számot és rövidítést tartalmaznak. Ne feledd, hogy a számok szavakkal való használatára vonatkozó szabályok eltérnek a műszaki világban. A régi szabály, miszerint az összes 10 alatti számot ki kell írni, nem mindig érvényes a technikai dokumentációkban. (Lásd számok vs szavak irányelvek.)
A technikai dokumentum szövegrészlete.
Egy műszaki írási tanfolyamon kérdezd meg az oktatódat, hogy a fejezetekhez szükséges-e a tizedes számformátum. Ezenkívül lehet, hogy egy másik dokumentálási rendszer szükséges—nem az IEEE, ami mérnököknek készült.
Grafikák és ábracímek
A műszaki dokumentumokban valószínűleg szüksége lesz rajzokra, diagramokra, táblázatokra és grafikonokra. Ezek nemcsak bizonyos információkat hatékonyabban közvetítenek, hanem a techdokumentumnak egy hozzáadott professzionális és tekintélyes megjelenést is kölcsönöznek. Ha még soha nem helyezett el ilyen típusú grafikákat egy dokumentumban, vannak viszonylag egyszerű módok arra, hogy ezt megtegye—nem szükséges, hogy professzionális grafikus legyen. A grafikák hozzáadására vonatkozó stratégiákért lásd grafika. Táblázatok hozzáadásának stratégiái s-hez, lásd asztalok.
Keresztutalások
Előfordulhat, hogy az olvasók figyelmét a techdositokban szorosan kapcsolódó információkra, vagy egyéb releváns információs forrásokra kell irányítanod. Ezeket úgy hívják, hogy keresztreferenciák. Például rámutathatnak az olvasókra egy mechanizmus megbeszéléséből egy annak illusztrációjára. Rámutathatnak az olvasókra egy függelékhez, ahol a témához háttérinformációt adnak (olyan háttér, ami egyszerűen nem illeszkedik a szövegbe). Rámutathatnak az olvasókra a techdokumentáción kívül más információkra—cikkekre, techdokumentációkra és könyvekre, amelyek a tiédhez kapcsolódó információkat tartalmaznak. Amikor keresztutalásokat készítesz, kövesd ezeket az irányelveket. kereszthivatkozások.
Következtetések
A legtöbb műszaki dokumentumhoz szükség lesz egy végső szakaszra. Amikor megtervezed a műszaki dokumentum végső szakaszát, gondolj a funkcióira a többi szakaszhoz képest. Az utolsó szakaszok ötletei a következőben találhatók: következtetések.
Mellékletek
A mellékletek azok az extra szakaszok, amelyek a következtetések után következnek. Mit tegyél a mellékletekbe?—minden olyan dolgot, ami nem illik kényelmesen a techdoc fő részébe, de nem hagyható ki a techdoc-ból. A mellékletet gyakran használják nagy adatlistákhoz, nagyobb kódrészletekhez, kihajtható térképekhez, olyan háttérinformációkhoz, amelyek túl alapvetőek vagy túl fejlettek a techdoc szövegéhez, vagy nagy illusztrációkhoz, amelyek egyszerűen nem illenek a . Bármi, amit túl nagynak érzel a techdoc fő részéhez képest, vagy amit úgy gondolsz, hogy zavaró lenne és megzavarná a techdoc folyamatosságát, jó jelölt egy melléklethez. Érdemes megjegyezni, hogy mindegyiknek betűt adnak (A, B, C, és így tovább).
Információs Források
Az információforrásaid dokumentálása arról szól, hogy megteremtsd, fenntartsd és megvédd a szakmai hitelességedet. Minden esetben hivatkoznod kell ("dokumentálni") a kölcsönzött információkra, függetlenül attól, hogy milyen formában vagy alakban mutatod be őket. Akár közvetlenül idézed, átírod vagy összefoglalod—még mindig kölcsönzött információról van szó. Akár könyvből, cikkből, diagramból, táblázatból, weboldalról, termékbrochúrából, akár egy szakértőtől, akit személyesen interjúvolsz meg—még mindig kölcsönzött információról van szó.
A dokumentációs rendszerek a szakemberek és területek szerint változnak. A mérnökök az IEEE rendszert használják, melynek példái az egész fejezet során megjelennek. Egy másik, gyakran használt dokumentációs rendszert az Amerikai Pszichológiai Társaság (APA) biztosít. Lásd dokumentáció további részletekért.
Oldalszámozás
A hagyományos technikai dokumentációs tervezésben használt oldalszámozási stílus eltér a modern technikai dokumentációs tervezéstől, elsősorban az előszóban (minden, ami a bevezetés előtt van) használt kisbetűs római számok miatt.
Megjegyzés: A hosszabb technikai dokumentumok gyakran a fejezetenkénti lapozási stílust használják, amelyet folio-by-chapter vagy kettős enumeráció néven is ismernek (például a 2. fejezet oldalaid 2-1, 2-2, 2-3 stb. számot kapnának). Hasonlóképpen, a táblázatok és a figurák is ezt a számozási stílust használnák. Ez a stílus megkönnyíti az oldalak hozzáadását és törlését.
AI Üzenetek a Techdokumentumokhoz
A checklisták, amelyeket általában nem olvasnak el, módosítással 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 hagyhattál ki.
Megjegyzés: Minden hivatkozás az alkalmazási levelek tartalmára, formátumára, stílusára vagy azok összetevőire a következő helyen található. online műszaki írás tankönyv.
|
AI Ötletek a Techdocs-hoz Amikor azt szeretnéd, hogy az AI értékelje egy írási projektet, mutatkozz be, mondd el, ki vagy, és mit szeretnél. Adj az AI-nak egy referenciapontot az értékeléshez, mint egy online tankönyv. Majd írd le, mit szeretnél, hogy a Gemini ellenőrizzen az értékelésében. Íme egy példa: Helló, AI. David McMurrey vagyok, kiberbiztonsági hallgató az Austin Community College-nál (Austin, Texas). Arra kérem, hogy értékelje az alábbi műszaki dokumentumot ezzel a online tankönyv és a következő kérdések: |
Kapcsolódó információk
Tartalomjegyzék: Egy Kulcsfontosságú Szervezési Eszköz az Olvasók Számára
Értékelném a gondolataidat, reakcióidat, kritikádat ezzel a fejezettel kapcsolatban: a válaszod—Dávid McMurrey.
