Electronic Documentation Design

Garant předmětu:

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 of informatics. The aim of the module is to acquaint students with configurable electronic documentation creating tools that present highly efficient alternatives to WYSIWYG editors and learn them how to produce well-formed technical reports.

Study materials:

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.

Note:

Further information:

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

No time-table has been prepared for this course

The course is a part of the following study plans:

• Bachelor branch Computer Science, in English, 2015-2020 original version (compulsory course in the program)