Táto online kniha o technickom písaní teraz používa technický dokument (technická dokumentácia skrátene) na označenie akéhokoľvek dokumentu, ktorý obsahuje technické informácie—na rozdiel od používania správa. Správa je podkategóriou spolu s ostatnými druhmi technických dokumentov rozoberanými v tejto knihe.

Poznámka: Táto učebnica technického písania sa zameriava na zručnosti technického písania. Technický obsah tu nie je zaručený ako presný alebo aktuálny.

Podkladové/informačné správy

Tento typ je najťažší na definovanie, ale zároveň ten, ktorý väčšina ľudí píše. Zameriava sa na technickú tému a poskytuje pozadie k tejto téme pre konkrétnu skupinu čitateľov, ktorá má k nej špecifické požiadavky. Táto správa neposkytuje pokyny, ani neposkytuje odporúčania žiadnym systematickým spôsobom, ani neobsahuje nové a originálne údaje.

Pre kompletnú kapitolu o tomto type technickej dokumentácie, pozri podkladové/informačné správy

Podnikateľské plány

Podnikateľský plán je dokument používaný na založenie nového podniku alebo na získanie financovania pre podnik, ktorý sa mení určitým významným spôsobom. Podnikateľské plány sú dôležité dokumenty pre obchodných partnerov, ktorí sa musia dohodnúť na svojich plánoch, pre úradníkov, ktorí musia tento plán schváliť, a samozrejme pre potenciálnych investorov, ako sú banky alebo súkromné osoby, ktoré môžu podnik financovať.

Pozrite si celá kapitola o tomto type technickej dokumentácie.

Technologicky-orientované používateľské príručky

Stručne definovaná, príručka pre používateľa počítača poskytuje technické informácie o tom, ako používať hardvér alebo softvér počítača, vrátane pokynov k takým úlohám, ako sú nastavenie, konfigurácia a základné úkony.

Pozri si celá kapitola o tomto type technickej dokumentácie.

Dátové správy

Dátová správa je technický dokument obsahujúci veľké množstvo údajov vo forme tabuliek. Môže tiež obsahovať grafy a diagramy, ktoré výraznejšie zobrazujú údaje v týchto tabuľkách, a vysvetľujúce krížové odkazy, ktoré uvádzajú kľúčové trendy a závery v tabuľkových údajoch.

Pozrite si celá kapitola o tomto type technickej dokumentácie.

Správy o inžinierskych návrhoch

Správa o inžinierskom návrhu predstavuje a dokumentuje inžiniersky návrh projektu tak, aby ostatní pochopili, ako možno návrh uplatniť a komercializovať. Napríklad inžinierski študenti písali o návrhu systému merania a zobrazovania teploty s využitím mikrokontroléra.

Pozri ten Prosím, vložte anglický text kapitoly, ktorú chcete preložiť. o tomto type technickej dokumentácie.

Príručky a usmerňovacie dokumenty

Stručne definované, a sprievodca je publikácia, ktorá poskytuje krok za krokom pokyny, tipy, súvisiace koncepty. Môže tiež obsahovať informácie o riešení problémov, odkazy na súvisiace komunity a odkazy na súvisiaci výskum.

A usmerňujúci dokument Je to vládny dokument určený na poskytnutie užitočných informácií verejnosti, napríklad na objasnenie povinností podľa platného zákona alebo nariadenia. Snaží sa preložiť zložité právne znenie administratívnych pravidiel tak, aby verejnosť mohla tieto pravidlá dodržiavať.

Pozri si úplná kapitola o týchto typoch technických dokumentov.

Príručky

Stručne povedané, príručka je ??? zdroj obsahujúci koncepčné informácie (základné teórie, princípy, základy), inštrukčné informácie (pokyny krok za krokom), a referenčné informácie (informácie na rýchle vyhľadanie).

Pozrite si celá kapitola o tomto type technickej dokumentácie.

Pokyny

Stručne povedané, inštrukcie vám hovoria, ako veci stavať, ako ich prevádzkovať, ako ich opravovať—klasický "návod, ako na to." Pre študentov technického písania uprednostňujte "Technologicky-orientované používateľské príručky."

Pozrite si celá kapitola o tomto type technickej dokumentácie.

Prehľady literatúry

Stručne povedané, prehľad literatúry zhrňuje, čo je známe o konkrétnej výskumnej téme, opisuje míľniky výskumnej histórie, poukazuje na miesta, kde sa súčasné poznatky rozchádzajú, a rozoberá oblasti, v ktorých stále zostávajú nezodpovedané otázky.

Pozrite si celá kapitola o tomto type technickej dokumentácie.

Primárne výskumné správy (laboratórne správy)

Stručne povedané, primárna výskumná správa prezentuje zistenia a interpretáciu z laboratórneho alebo terénneho výskumu. Môžete ju považovať za laboratórnu správu, ale je to omnoho viac než to.

Pozrite si celá kapitola o tomto type technickej dokumentácie.

Správy o pokroku

Stručne povedané, správa o pokroku informuje nadriadeného, spolupracovníka alebo zákazníka o priebehu projektu počas určitého časového obdobia. Projekt môže byť návrh, výstavba alebo oprava niečoho, štúdium alebo výskum problému či otázky, alebo zhromažďovanie informácií o technickej téme.

Pozri to celá kapitola o tomto type technickej dokumentácie.

Návrhy

Stručne povedané, návrh je ponuka alebo záväzok vykonať určitý projekt pre niekoho. To, čo z návrhu robí návrh, je to, že žiada adresátov, aby schválili, financovali alebo udelili povolenie na realizáciu navrhovaného projektu.

Pozrite si celá kapitola o tomto type technickej dokumentácie.

Odporúčacie správy, správy o uskutočniteľnosti, hodnotiace správy

Táto skupina podobných správ robí veci ako porovnáva niekoľko možností s množinou požiadaviek a odporúča jednu; zvažuje myšlienku (plán, projekt) z hľadiska jej "feasibility," napríklad, niektorej kombinácie technickej, ekonomickej a sociálnej praktickosti alebo možnosti; posudzuje hodnotu veci porovnaním s množinou požiadaviek (kritérií).

Pozrite si úplná kapitola o týchto typoch technickej dokumentácie.

Štandardné prevádzkové zásady a postupy

Toto sú prevádzkové dokumenty pre organizácie; obsahujú pravidlá a predpisy o tom, ako sa očakáva, že organizácia a jej členovia budú postupovať. Politiky a postupy sú ako pokyny, ale idú oveľa ďalej. Štandardné operačné postupy (SOPs) sú skôr určené pre postupy, pri ktorých sa vykonáva proces—napríklad zhotovenie zubného odtlačku.

Pozrite si celá kapitola o týchto typoch technickej dokumentácie.

Vydanie technickej knihy

Čoskoro...

Pozrite si celá kapitola o tomto type technickej dokumentácie.

Technologicky zamerané používateľské návody

Stručne povedané, používateľská príručka k počítaču poskytuje technické informácie o tom, ako používať počítačový hardvér alebo softvér, vrátane pokynov pre úlohy ako inštalácia, konfigurácia a základné úkony.

Pozri si celá kapitola o tomto type technickej dokumentácie.

Biele knihy

Stručne povedané, biela kniha je technologický alebo obchodný dokument, ktorý poskytuje pozadie o projekte (zariadení, metóde atď.) a obhajuje ho. Biele knihy sa stali obľúbenými marketingovými nástrojmi pre korporácie, najmä na internete, pretože mnohí potenciálni zákazníci vyhľadávajú informácie na webe. Korporácie používajú biele knihy na predaj informácií alebo nových produktov ako riešení, ktoré by uspokojili potreby ich zákazníkov.

Pozrite si celá kapitola o tomto type technickej dokumentácie.

Súvisiace informácie

Typy dokumentov a ako ich používať. Čo robiť