Electronic Documentation Design

Lecturer:

Ondřej Guth

Tutor:

Ondřej Guth

Supervisor:

Department of 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.

7. TeX typesetting system.

Syllabus of tutorials:

1. Generating diagrams using Graphviz.

2. Generating graphs using Gnuplot.

3. Source code documentation with Doxygen.

4. LaTeX I.

5. Knowledge test, creating presentations with LaTeX-Beamer.

6. LaTeX II.

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://edux.fit.cvut.cz/courses/BI-TED/en/start

Time-table for winter semester 2011/2012:

Time-table is not available yet

Time-table for summer semester 2011/2012:

	06:00–08:0008:00–10:0010:00–12:0012:00–14:0014:00–16:0016:00–18:0018:00–20:0020:00–22:0022:00–24:00
Mon	roomTH:A-1030 Guth O. 09:15–10:45 ODD WEEK (lecture parallel1) Dejvice roomTH:A-1029 Guth O. 09:15–10:45 EVEN WEEK (lecture parallel1 parallel nr.101) Dejvice
Tue
Fri
Thu
Fri

The course is a part of the following study plans:

• Information Systems and Management (Presented in English) (compulsory course in the program, compulsory course of the specialization)
• Information Technologies (Presented in English) (compulsory course in the program, compulsory course of the specialization)
• Computer Engineering (Presented in English) (compulsory course in the program, compulsory course of the specialization)
• Software Engineering (Presented in English) (compulsory course in the program, compulsory course of the specialization)
• Computer Science (Presented in English) (compulsory course in the program, compulsory course of the specialization)
• Web and Multimedia (Presented in English) (compulsory course in the program, compulsory course of the specialization)
• Informatics (Presented in English) (compulsory course in the program, VO)