Electronic Documentation Design

Garant předmětu:

Přednášející:

Cvičící:

Předmět zajišťuje:

katedra teoretické informatiky

Anotace:

Studenti se naučí správně psát technické zprávy za použití konfigurovatelných nástrojů vhodných pro informatické profesionály. Rozšíří své schopnosti v oblasti přístupu k tvorbě elektronických dokumentů. Seznámí se s dokumentováním softwarových projektů, zejména se základy UML a s dokumentováním zdrojových kódů.

Požadavky:

Znalost základních programových nástrojů ze sady OpenOffice nebo MS Office a pravopisu.

Osnova přednášek:

1. Textový editor vs. typografický systém, oddělení formy a obsahu (např. styly), ukládání textu a kódování - znakové sady.

2. Typografický systém LaTeX.

3. Úvod do typografie.

4. Grafika (rastrová vs. vektorová, barevné modely, umístění obrázků do textu a číslování obrázků).

5. Citace literatury, literární zdroje, etika publikování, nástroje na zpracování citací (BibTeX, ...).

6. Zásady pro přípravu a přednes prezentací.

Osnova cvičení:

1. Tvorba diagramů pomocí Graphviz.

2. Tvorba grafů pomocí Gnuplot.

3. Sazba pomocí LaTeX.

4. Sázecí systém TeX.

5. Dokumentace zdrojového kódu.

6. Tvorba prezentací pomocí LaTeX-Beamer.

Cíle studia:

Tvorba elektronické dokumentace je důležitou součástí znalostí a dovedností studenta informatiky. Cílem předmětu je seznámit studenty s programovatelnými nástroji pro tvorbu elektronické dokumentace, které tvoří velmi efektivní alternativy WYSIWYG editorů, a naučit je psát technické zprávy vysoké kvality.

Studijní materiály:

1. Voss, H. „Typesetting tables with LaTeX“. UIT Cambridge, 2011. ISBN 978-1-906860-25-7.

2. Janert, P.K. „Gnuplot in Action“. Manning Publications, Greenwich, 2010. ISBN 978-1-933988-39-9.

3. Salomon, D. „The Advanced TeXbook“. Springer-Verlag New York, 1995. ISBN 0-387-94556-3.

Poznámka:

Information about the course and courseware are available at https://courses.fit.cvut.cz/BI-TED/

A student who lacks the course TED, must register for the courseTEX.

A student who has been recognized the course TED from previous studies will be recognized the course TEX.

Další informace:

https://courses.fit.cvut.cz/BI-TED/

Pro tento předmět se rozvrh nepřipravuje

Předmět je součástí následujících studijních plánů:

• Bachelor branch Computer Science, in English, 2015-2020 original version (povinný předmět programu)