Logo ČVUT
CZECH TECHNICAL UNIVERSITY IN PRAGUE
STUDY PLANS
2019/2020

Electronic Documentation Design

The course is not on the list Without time-table
Code Completion Credits Range Language
BI-TED KZ 5 2P+1C Czech
Lecturer:
Tutor:
Supervisor:
Department of Theoretical Computer Science
Synopsis:

Students are able to create electronic documentation, namely technical reports. They learn alternatives of WYSIWYG editors and are able to produce well-formed technical reports using configurable tools appropriate for ICT professionals. They learn the documentation of software projects, including basics of UML and documentation of source code.

Requirements:

Knowledge of basic software tools from OpenOffice or MS Office packages, spelling and orthography.

Syllabus of lectures:

1. Text editor vs. typesetting system, separation of appearance and content (e.g. styles), text storage and encoding (charsets).

2. LaTeX typesetting system.

3. Introduction to typography.

4. Graphics (raster vs. vector graphics, color models, placement and numbering of figures).

5. Law of citation, literary resources, publication ethics, bibliography tools (e.g. BibTeX).

6. Presentations.

Syllabus of tutorials:

1. Generating diagrams using Graphviz.

2. Generating graphs using Gnuplot.

3. Typesetting in LaTeX.

4. Typesetting system TeX.

5. Source code documentation.

6. Creating presentations with LaTeX-Beamer.

Study Objective:

The creation of electronic documentation is an important skill for students. After completing this course, students will be able to produce well-formed technical reports using configurable tools appropriate for IT experts. The aim is to broaden their skills regarding the approach to the creation of electronic documents. Students will be introduced to the documentation of software projects; this includes basics of UML and documentation of source code.

Study materials:

1. Beran, V. ''Typografický manuál: učebnice počítačové typografie''. Náchod: Manuál, 1994. ISBN 80-901824-0-2.

2. Olšák, P. ''Typografický systém TeX''. Brno: Konvoj, 2000. ISBN 80-85615-91-6.

3. Rybička, J. ''LaTeX pro začátečníky''. Brno: Konvoj, 2003. ISBN 80-7302-049-1.

4. Bratková, E.: Metody citování literatury a strukturování bibliografických záznamů podle mezinárodních norem ISO 690 a ISO 690-2, Asociace knihoven vysokých škol České republiky, 2006.

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

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

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

Note:
Further information:
No time-table has been prepared for this course
The course is a part of the following study plans:
Data valid to 2019-09-22
For updated information see http://bilakniha.cvut.cz/en/predmet1121906.html