Prosím, kliknite sem, aby ste pomohli David McMurrey zaplaťte za web hosting:
Darujte akúkoľvek malú sumu, ktorú môžete!
Online technické písanie zostane bezplatné.
Technické dokumenty (vrátane príručiek, bielych kníh a sprievodcov) majú rôzne dizajny v závislosti od odvetvia, profesie alebo organizácie. Táto kapitola vám ukáže jeden tradičný dizajn. Ak navštevujete kurz technického písania, uistite sa, že dizajn uvedený v tejto kapitole je prijateľný. To isté platí, ak píšete technický dokument v kontexte vedy, podnikania alebo vlády.
Infografika generovaná NotebookLM o tejto kapitole
Poznámka: Po celé roky táto online učebnica technického písania všeobecne nazývala správy prakticky čímkoľvek, čo obsahovalo technické informácie. Avšak pretože "správa" sa týka konkrétneho žánru technického dokumentu, bolo potrebné prejsť na všeobecný termín "techdoc," čo je skrátená forma pre technický dokument.
Techdocs (všeobecný názov pre technické dokumenty) majú špecifikácie, rovnako ako akýkoľvek iný druh projektu. Špecifikácie pre techdocs obsahujú rozloženie, organizáciu a obsah, formát nadpisov a zoznamov, dizajn grafiky a tak ďalej. Výhodou požadovanej štruktúry a formátu pre techdocs je, že vy alebo ktokoľvek iný môžete očakávať, že budú navrhnuté známym spôsobom —viete, na čo sa zamerať a kde to hľadať. Techdocs sa zvyčajne čítajú v zhone — ľudia sú v zhone, aby sa dostali k informáciám, ktoré potrebujú, k kľúčovým faktom, záverom a iným podstatným informáciám. Štandardný formát techdoc je ako známe okolie.
Keď analyzujete dizajn technickej dokumentácie, všimnite si, ako sú niektoré sekcie opakujúce sa. Toto duplicitné informácie súvisí s tým, ako ľudia čítajú technickú dokumentáciu. Nečítajú ju od začiatku do konca: môžu začať s výexecutívnym súhrnom, preskakovať a pravdepodobne neprečítajú každú stránku. Vašou výzvou je navrhnúť technickú dokumentáciu tak, aby títo čitatelia narazili na vaše kľúčové fakty a závery, bez ohľadu na to, koľko z dokumentácie prečítajú alebo v akom poradí ju čítajú.
Určite si pozri príklad technických dokumentov.
Štandardné komponenty typickej technickej správy sú prediskutované v tejto kapitole. Nasledujúce sekcie vás prevedú každým z týchto komponentov a upozornia na kľúčové znaky. Keď čítate a používate tieto pokyny, pamätajte, že to sú pokyny, nie príkazy. Rôzne spoločnosti, profesie a organizácie majú svoje vlastné rôzne pokyny pre technické dokumenty —, budete musieť prispôsobiť svoju prax týmto, ako aj tým, ktoré sú tu prezentované.
Prenosová správa
Transmittálna správa je buď sprievodný list (alebo memo) alebo e-mail. Fyzický list (alebo memo) je buď pripevnený zvonka technickej dokumentácie pomocou papierovej sponky, alebo je viazaný v technickej dokumentácii. E-mail obsahuje odkaz na technickú dokumentáciu alebo je v ňom technická dokumentácia priložená. Je to komunikácia od vás—autor technickej dokumentácie—k príjemcovi, osobe, ktorá požiadala o technickú dokumentáciu a ktorá vám môže dokonca platiť za vašu odbornú konzultáciu. V podstate to hovorí "Dobre, tu je technická dokumentácia, ktorú sme sa dohodli, že dokončím do tohto a toho dátumu. Stručne, obsahuje toto a tamto, ale nekryje toto alebo tamto. Dajte mi vedieť, či vyhovuje vašim potrebám." Transmittálna správa vysvetľuje kontext—udalosti, ktoré priviedli k vytvoreniu technickej dokumentácie. Obsahuje informácie o technickej dokumentácii, ktoré nepatria do technickej dokumentácie.
Príklady sprievodného listu a sprievodnej správy.
V príklade sprievodného listu si všimnite štandardný formát obchodného listu. Ak píšete interný technický dokument, použite formát memoranda; v oboch prípadoch je obsah a organizácia rovnaká:
Prvý odsek. Uvedie názov technického dokumentu, ktorý bude písaný kurzívou. Taktiež spomína dátum dohody na napísanie technického dokumentu.
Stredný odsek. Zameriava sa na účel techdod a poskytuje stručný prehľad obsahu techdodu.
Záverečný odstavec. Povzbudzuje čitateľa, aby sa skontaktoval, ak má otázky, pripomienky alebo obavy. Zakončuje gestom dobrej vôle, vyjadrujúc nádej, že čitateľ považuje techdoc za uspokojivý.
Rovnako ako pri akomkoľvek inom prvku v technickej dokumentácii, môžete musieť upraviť obsah tejto správy (alebo mema) pre konkrétne situácie. Napríklad možno budete chcieť pridať ďalší odsek, v ktorom uvediete otázky, nad ktorými by ste chceli, aby čitatelia premýšľali, keď si prezerajú technickú dokumentáciu.
Obaly, Titulná strana a Nápis
Ak je váš technický dokument dlhší ako desať strán, zviažte ho nejakým spôsobom a vytvorte štítok na obal.
Kryty
Obaly dodávajú technickým dokumentom pevnú, profesionálnu atmosféru a zároveň ochranu. Môžete si vybrať z mnohých typov obalov. Majte na pamäti nasledujúce tipy:
- Úplne neprijateľné sú jasné (alebo farebné) plastové obaly s plastovým rukávom na ľavom okraji. Tieto sú ako niečo z prvej angličtiny; plus sú nepríjemné na používanie—čítači musia bojovať, aby ich udržali otvorené a vyrovnávať sa s elektrostatickým nábojom, ktorý generujú.
- Marginalne prijateľné sú obaly, do ktorých vysekávate otvory na stránkach, nahrádzate stránky a ohýbate sponky. Ak používate tento typ, nechajte na ľavom okraji extra pol palca maržu, aby čitatelia nemuseli rozťahovať stránky. Samozrejme, tento typ obalu bráni stránkam ležať rovno: čitatelia musia uchopiť dostupné objekty alebo použiť rôzne časti tela, aby stránky zostali zaťažené.
- Najlepšie obaly sú tie, ktoré umožňujú technickým dokumentom ležať otvorené samostatne (pozri ilustráciu v nasledujúcej sekcii). Aké veľké uvoľnenie je mať technický dokument rozložený na kolenách alebo na stole. Tento typ využíva plastovú špirálu na viazanie a hrubý, kartónový papier na obaly. Overte si v miestnej copy shop pre tieto typy väzieb; sú lacné a pridávajú profesionalitu vašej práci. Pozrite si simulovaný príklad plastovej špirálovej väzby nižšie.
Vo všeobecnosti sú menej preferované zošitové zápisníky alebo zakladače na krúžky. Tieto sú príliš objemné pre krátke technické dokumenty a diery na stránkach sa majú tendenciu trhať. Samozrejme, zakladač na krúžky uľahčuje výmenu strán; ak sa takto váš technický dokument bude používať, potom je to dobrá voľba. Na "vyššom konci" sú prehnane okúzľujúce obaly s ich koženým vzhľadom a zlatými detailmi. Vyhnite sa im—držte to jednoduché, čisté a funkčné.
Titulná strana
V najjednoduchšej forme je titul technickej dokumentácie kópiou toho, čo je na prednej obálke—možno s pridaním niekoľkých detailov.
Pozrite sa na titulnú stranu Abstrakt a výkonný súhrn.
Štítky
Určite vytvorte štítok pre obal vášho technického dokumentu. Je to krok, na ktorý niektorí autori technických dokumentov zabúdajú. Bez štítku je technický dokument anonymný; zostáva bez povšimnutia.
Najlepším spôsobom, ako vytvoriť etiketu, je použiť svoj softvér na spracovanie textu na navrhnutie etikety na štandardnej stránke s grafickým rámčekom okolo informácií na etike. Vytlačte ju, potom choďte do kopírovacieho obchodu a nechajte si ju skopírovať priamo na obal technického dokumentu.
Na štítku nie je veľa informácií: názov technickej dokumentácie, vaše meno, názov vašej organizácie, číslo sledovania technickej dokumentácie a dátum. Neexistujú žiadne štandardné požiadavky na štítok, hoci vaša spoločnosť alebo organizácia by mala mať svoje vlastné požiadavky. (Príklad štítku technickej dokumentácie je zobrazený nižšie.)
Sprievodný list a technická dokumentácia (s obalovým štítkom).
Abstrakt a výkonný súhrn
Väčšina technických technických dokumentov obsahuje aspoň jeden abstrakt—niekedy aj dva, pričom abstrakty zohrávajú rôzne úlohy. Abstrakty zhrnujú obsah technického dokumentu, ale rôzne typy to robia rôznymi spôsobmi:
- Popisný abstrakt. Tento typ poskytuje prehľad o účele a obsahu technickej dokumentácie. V niektorých dizajnoch technickej dokumentácie je popisný abstrakt umiestnený na spodnej časti titulnej strany, ako je znázornené nižšie:
Popisný abstrakt. Tradične sa umiestňuje na titulnej strane (nie na obálke). - Výkonný súhrn. Ďalším bežným typom je exekutívny súhrn, ktorý taktiež sumarizuje kľúčové fakty a závery obsiahnuté v techdoc. Pozrite si príklad uvedený nižšie. Je to, akoby ste použili žltý zvýrazňovač na označenie kľúčových viet v techdoc a potom ich všetky prešli na samostatnú stránku a upravili ich pre lepšiu čitateľnosť. Typicky sú exekutívne súhrny od desiatich do dvadsiatich percent dĺžky techdocs dlhých desať až päťdesiat strán. Pre dlhšie techdocs, teda tie nad päťdesiat strán, by exekutívny súhrn nemal presiahnuť dve strany. Cieľom exekutívneho súhrnu je poskytnúť súhrn techdoc—niečo, čo sa dá rýchlo prečítať.
Ak vám príde výexecutívne zhrnutie, úvod a prenosová správa opakujúce sa, pamätajte, že čitatelia nečítajú nutne od začiatku technického dokumentu po stránku až do konca. Skáču si vedľa: môžu si prehliadať obsah; zvyčajne rýchlo prejdú výexecutívne zhrnutie za kľúčové fakty a závery. Môžu si pozorne prečítať iba sekciu alebo dve z tela technického dokumentu a potom preskočiť zvyšok. Z týchto dôvodov sú technické dokumenty navrhnuté s určitým duplicitným obsahom, aby čitatelia mali istotu, že uvidia dôležité informácie bez ohľadu na to, kde sa do technického dokumentu ponoria.
Obsah (čo príde prvé) potom stručné zhrnutie.
Obsah
Akýkoľvek formát obsahu (TOC), ktorý použijete, sú to bežné štandardy:
- Číslovanie strán začína iba. Aj keď niektoré automatické generátory obsahu zobrazujú rozsah stránok, štandardne sa uvádza iba číslo prvej stránky.
- Úrovne nadpisov, ktoré je potrebné zahrnúť. Ako je uvedené v obsahu vyššie, zobrazte najvyššie dve úrovne nadpisov, pokiaľ technická dokumentácia nemá veľa podnadpisov. Obsah by mal poskytnúť prehľadný spôsob rýchleho vyhľadávania informácií.
- Medzery a veľké písmená. Všimnite si, ako sú textové položky v obsahu nad indentované. Hlavné nadpisy používajú veľké písmená; druhé úrovne nadpisov používajú veľké písmená na začiatku každého hlavného slova; nadpisy tretej úrovne používajú kapitálky v štýle viet.
- Vertikálne odstupy. Upozorňujeme, že sekcie prvej úrovne majú nad a pod nimi extra priestor, čo zvyšuje čitateľnosť.
- Všetky stránky v technickej dokumentácii (vrátane, ale nie vrátane prednej a zadnej obálky) sú očíslované; ale na niektorých stránkach čísla nie sú zobrazené.
- V súčasnom dizajne používajú všetky stránky v dokumente arabské číslice; v tradičnom dizajne používajú všetky stránky pred úvodom (prvá stránka textu) malé rímske číslice.
- Na špeciálnych stránkach, ako je titulná stránka a stránka jedna úvodu, čísla stránok nie sú zobrazené.
- Čísla stránok môžu byť umiestnené v jednej z viacerých oblastí na stránke. Zvyčajne je najlepšou a najjednoduchšou voľbou umiestniť čísla stránok do dolného stredu stránky (nezabudnite ich skryť na špeciálnych stránkach).
- Ak umiestnite čísla strán na vrch stránky, musíte ich skryť na začiatkoch kapitol alebo sekcií, kde sa na vrchu stránky nachádza nadpis alebo titul.
- Obsahuje technická dokumentácia (správa) nasledujúce (správne naformátované) v tomto poradí: správa o zaslaní; titulná strana; obsah; zoznam obrázkov, tabuliek alebo oboch; úvod; hlavné sekcie (kapitoly); prílohy (podľa potreby); zdroje informácií; zadný obal (ak je potrebný). Pre podrobnosti pozri Návrh technickej dokumentácie.
- Hoci môže byť názov technického dokumentu inteligentný a hravý, adekvátne naznačuje jeho tému? Na podrobnosti pozri Techdoc názvy.
- Ak obsah a zoznam obrázkov (a tabuliek) používajú vodorovné bodky, sú čísla strán zarovnané vpravo? Ak obsah a zoznam obrázkov (a tabuliek) obsahujú čísla strán na pravej strane stránky, používajú sa vodorovné bodky? Pre podrobnosti, pozri Obsahy a zoznamy obrázkov (tabuliek).
- Zohľadňuje úvod adekvátne tému, účel a cieľovú skupinu technickej dokumentácie? Poskytuje zoznam podtém, ktoré budú pokryté, a uvedenie rozsahu (čo nie je pokryté)? Pre podrobnosti, pozrite sa na Úvody.
- Obsahuje tento technický dokument dostatočné podrobnosti, špecifiká, príklady—čokoľvek potrebné na vysvetlenie tvrdení, všeobecností?
- Zohľadňujúc tému, cieľ a publikum, chýbajú v tejto technickej dokumentácii nejaké dôležité obsahy? Sú nejaké obsahy zbytočné? Je v tejto technickej dokumentácii nejaká informácia technicky nesprávna? Chýba nejaká kritická technická informácia?
- V tejto technickej dokumentácii sa nachádza nejaká zjavne prevzatá informácia, ktorá nie je nijako zdokumentovaná?
- Vyskytujú sa citácie (odkazy na položky v zozname informačných zdrojov) v tele technického dokumentu formátovaného podľa štýlu APA, MLA alebo modifikovaného IEEE? Sú položky v zozname informačných zdrojov formátované podľa štýlu APA, MLA alebo modifikovaného IEEE? Na podrobnosti pozrite Dokumentácia: požičané informačné zdroje.
- Zahŕňajú všetky tabuľky a nedekoratívne obrázky popisný názov (titulek) a zdroj (ak je potrebný)? Pre podrobnosti, pozri Názvy tabuliek.
- Vyskytujú sa všetky tabuľky a nedekoratívne obrázky čo najbližšie k súvisiacemu textu?
- Kedysi sa krátke vysvetľujúce odkazy objavili pred tabuľkami a nedekoratívnymi obrázkami? Pre podrobnosti pozri Vysvetľujúce krížové odkazy.
- Je v tele technického dokumentu použitý štandardný formát nadpisov a podnadpisov? Pre podrobnosti pozri Nadpisy.
- Začínajú hlavné sekcie (kapitoly) technickej dokumentácie novou stránkou v tlačených verziách?
- Sú číslované vertikálne zoznamy použité pre položky zoznamu v požadovanom poradí? Sú odrážkové vertikálne zoznamy použité pre položky zoznamu bez požadovaného poradia? Používajú sa úvodné vety pred všetkými zoznamami? Pre podrobnosti pozrite Vertikálne zoznamy.
- Sú priame citácie priradené a sú priradenia správne interpunkčne? Sú všetky priame citácie, zhrnutia a parafrázy správne citované podľa štýlu APA, MLA alebo modifikovaného IEEE? Pre podrobnosti pozrite Citáty a príspevky.
- Je text technickej dokumentácie bez gramatických, písacích a interpunkčných chýb? Pre podrobnosti pozri Bežné gramatické, užívateľské a pravopisné problémy.
- Je text technickej dokumentácie zbavený zbytočnej slovnej zásoby a iných chýb vo štýle viet? Pre podrobnosti, pozrite si Nadbytočnosť, iné problémy so štylom viet.
- Môže byť tento technický dokument pochopený svojou cieľovou skupinou (ako je uvedené v správe o zaslaní a úvode)? Pre podrobnosti, pozrite sa na Analýza publika, a vidieť Preklad technického.
- AI, na dokončenie tvojej hodnotenia mojej technickej dokumentácie, priraď číselnú známku v rozmedzí od 100 do 55.
Vedúce bodky a čísla strán orientované vpravo. Pre tradičný obsah, ktorý používa vodítka a čísla strán zarovnané doprava:
Pravé zarovnanie. V tomto príklade, všimnite si, že vodorovné body "vedú" k číslam strán, ktoré sú zarovnané doprava.
Vodítka a čísla stránok zarovnané vpravo.
Tento obsah používa desatinný číslovací štýl pre čísla kapitol a sekcií, čo je bežné v technických dokumentoch. Iné v tejto knihe používajú štýl veľkých rímskych číslic iba pre kapitoly najvyššej úrovne (pozri ).
Problémy so vytvorením pekne naformátovanej obsahu? Pozri sa na Vytvorte profesionálne vyzerajúci obsah.
Čačky a čísla strán. Ak formát s vodorovnou bodkou nie je potrebný a uprednostňujete jeho vyhnutie, môžete použiť tento bežne akceptovaný formát:
|
3. KĽÚČOVÉ PRINCÍPY ENERGETICKEJ ÚČINNOSTI, 5
Pasívne návrhové stratégie, 6
4. NORMY A CERTIFIKÁTY, 11Aktívne energetické systémy, 7 Integrácia obnoviteľnej energie, 9
LEED, 11
Energetická hviezda, 12 Žijúca budova, 14 |
Zoznam obrázkov a tabuliek
Zoznam obrázkov má mnoho rovnakých dizajnových úvah ako obsah. Čitatelia používajú zoznam obrázkov na nájdenie ilustrácií, diagramov, tabuliek a grafov vo vašej technickej dokumentácii.
Komplikácie vznikajú, keď máte súčasne tabuľky a obrázky. Prísne vzaté, obrázky sú ilustrácie, kresby, fotografie, grafy a diagramy. Tabuľky sú riadky a stĺpce slov a čísiel; nie sú považované za obrázky.
Pre dlhšie technické dokumenty, ktoré obsahujú desiatky obrázkov a tabuliek, vytvorte samostatné zoznamy obrázkov a tabuliek. Skombinujte ich na rovnakú stránku, ak sa zmestia, ako je zobrazené na ilustrácii nižšie. Môžete skombinovať oba zoznamy pod nadpisom „Zoznam obrázkov a tabuliek“ a identifikovať položky ako obrázok alebo tabuľku, ako je to znázornené na ilustrácii nižšie.
Úvod
Základným prvkom každého technického dokumentu je jeho úvod—uistite sa, že ste si jasne vedomí jeho skutočného účelu a obsahu. V technickom dokumente úvod pripravuje čitateľa na čítanie hlavnej časti technického dokumentu. Pozrite sa úvody na diskusiu o písaní úvodov.
Pozrite si tento príklad úvodu:
Zoznam obrázkov a tabuliek nasleduje po úvode.
Ak nie sú žiadne tabuľky, urobte to "Zoznam ilustrácií." Na kurze technického písania sa opýtajte svojho učiteľa, či je požadovaný desatinný číslovací štýl pre nadpisy.
Telo Techdocu
Telo techdokumentu je samozrejme hlavný text techdokumentu, sekcie medzi úvodom a záverom. Nižšie sú zobrazené ukážkové stránky.
Nadpisy
Vo všetkých, okrem najkratších technických dokumentov (dve strany alebo menej), používajte nadpisy na vyznačenie rôznych tém a podtém, ktoré sú zahrnuté. Nadpisy umožňujú čitateľom prebehnúť váš technický dokument a zamerať sa na tie body, kde prezentujete informácie, ktoré chcú. nadpisy pre pokyny k nadpisom.
Odrážkové a číslované zoznamy
V tele technického dokumentu používajte aj odrážkové, číslované a dvojstĺpcové zoznamy tam, kde je to vhodné. Zoznamy pomáhajú zdôrazniť kľúčové body, uľahčujú sledovanie informácií a rozbíjajú súvislé textové bloky. Pozrite sa zoznamy na pokyny týkajúce sa zoznamov.
Symboly, čísla a skratky
Technické diskusie zvyčajne obsahujú množstvo symbolov, čísel a skratiek. Pamätajte, že pravidlá na používanie čísel oproti slovám sa v technickom svete líšia. Staré pravidlo o písaní všetkých čísel pod 10 sa v technických dokumentoch vždy neuplatňuje. (Pozri čísla vs slová pre smernice.)
Okrem textu v tele technického dokumentu.
Na kurze technického písania sa opýtajte svojho inštruktora, či je požadovaný desatinný systém číslovania pre nadpisy. Taktiež môže byť potrebný iný dokumentačný systém—nie IEEE, ktorý je pre inžinierov.
Grafika a názvy obrázkov
V technických dokumentoch pravdepodobne budete potrebovať výkresy, diagramy, tabuľky a grafy. Tieto nielenže prenášajú určité druhy informácií efektívnejšie, ale tiež dodávajú vášmu technickému dokumentu dodatočný vzhľad profesionality a autority. Ak ste nikdy nepridali tieto druhy grafiky do dokumentu, existujú niektoré relatívne jednoduché spôsoby, ako to urobiť—nemusíte byť profesionálny grafický umelec. Pre stratégie na pridanie grafiky do s, pozrite sa grafika. Pre stratégie pridávania tabuliek do s, pozri stoly.
Prepojenia
Môžete potrebovať nasmerovať čitateľov na úzko súvisiace informácie vo vašich techdo, alebo na iné zdroje informácií, ktoré obsahujú relevantné informácie. Tieto sa nazývajú krížové odkazy. Napríklad môžu nasmerovať čitateľov z diskusie o mechanizme na jeho ilustráciu. Môžu nasmerovať čitateľov na prílohu, kde sú poskytnuté základné informácie o téme (základné informácie, ktoré sa jednoducho nehodia do textu). A môžu nasmerovať čitateľov mimo vášho technického dokumentu na ďalšie informácie—na články, technické dokumenty a knihy, ktoré obsahujú informácie súvisiace s vaším. Keď vytvárate krížové odkazy, dodržujte tieto usmernenia uvedené v krížové odkazy.
Závery
Pre väčšinu technických dokumentov bude potrebné zahrnúť konečnú sekciu. Keď plánujete konečnú sekciu svojho technického dokumentu, zamyslite sa nad funkciami, ktoré môže vykonávať v súvislosti s ostatnými časťami technického dokumentu. Nápady na konečné sekcie sú predstavené v závery.
Prílohy
Prílohy sú tie extra sekcie nasledujúce po závere. Čo dávaš do príloh?—všetko, čo sa pohodlne nezmestí do hlavnej časti technickej dokumentácie, ale nemôže byť úplne vynechané z technickej dokumentácie. Príloha sa bežne používa na veľké tabuľky údajov, veľké úseky vzorového kódu, rozkladacie mapy, pozadie, ktoré je príliš základné alebo príliš pokročilé pre telo technickej dokumentácie, alebo veľké ilustrácie, ktoré jednoducho nezapadajú do tela. Čokoľvek, čo považuješ za príliš rozsiahle pre hlavnú časť technickej dokumentácie alebo čo si myslíš, že by bolo rušivé a prerušilo tok technickej dokumentácie, je dobrým kandidátom na prílohu. Všimni si, že každá príloha má pridelené písmeno (A, B, C a tak ďalej).
Informačné zdroje
Dokumentovanie vašich informačných zdrojov je predovšetkým o ustanovení, udržiavaní a ochrane vašej dôveryhodnosti v profesii. Musíte citovať ("dokumentovať") požičané informácie bez ohľadu na tvar alebo formu, v ktorej ich prezentujete. Či už to priamo citujete, parafrázujete alebo sumarizujete—je to stále požičaná informácia. Či už pochádza z knihy, článku, diagramu, tabuľky, webovej stránky, produktového brožúry, alebo od odborníka, ktorého osobne interviewujete—je to stále požičaná informácia.
Systémy dokumentácie sa líšia podľa profesií a oblastí. Inžinieri používajú systém IEEE, ktorého príklady sú uvedené v tejto kapitole. Ďalší často používaný systém dokumentácie poskytuje Americká psychologická asociácia (APA). Pozrite sa dokumentácia pre podrobnosti.
Číslovanie stránok
Štýl číslovania strán používaný v tradičnom dizajne technickej dokumentácie sa líši od súčasného dizajnu technickej dokumentácie predovšetkým tým, že v prednej časti (všetko pred úvodom) používa malé rímske číslice.
Poznámka: Dlhšie technické dokumenty často používajú spôsob číslovania strán známy ako folio podľa kapitoly alebo dvojité číslovanie (napríklad, stránky v kapitole 2 by boli číslované 2-1, 2-2, 2-3 a tak ďalej). Podobne by tabuľky a obrázky používali tento spôsob číslovania. Tento spôsob uľahčuje proces pridávania a odstraňovania strán.
AI Výzvy pre Techdocs
Kontrolné zoznamy, ktoré zvyčajne ostávajú nepovšimnuté, môžu byť použitými ako zdroj pre AI podnety s určitou úpravou. Skopírujte nasledujúce, vložte to do AI systému ako je Google Gemini a zistite, čo ste možno prehliadli.
Poznámka: Všetky odkazy na obsah, formát, štýl žiadostí o zamestnanie alebo ich komponenty možno nájsť v online učebnica technického písania.
|
AI výzvy pre Techdocs Keď chcete, aby AI vyhodnotila písací projekt, predstavte sa, povedzte AI, kto ste a čo chcete. Poskytnite AI referenčný bod pre hodnotenie, ako je online učebnica. Potom zverejnite, čo chcete, aby Gemini skontrolovala vo svojom hodnotení. Tu je príklad: Ahoj, AI. Som David McMurrey, študent kybernetickej bezpečnosti na Austin Community College (Austin, Texas). Žiadam, aby si vyhodnotil nasledujúci technický dokument pomocou tohto. online učebnica a nasledujúce otázky: |
Súvisiace informácie
OBSAH: Kľúčový organizačný nástroj pre čitateľov
Bolo by pre mňa cenné počuť vaše myšlienky, reakcie, kritiku týkajúcu sa tejto kapitoly: tvoja odpoveď—David McMurrey.
