Electronic Documentation Design
| Code | Completion | Credits | Range | Language |
|---|---|---|---|---|
| BI-TED | KZ | 5 | 2+1 | Czech |
- Lecturer:
- Ondřej Guth, Jan Holub (gar.)
- Tutor:
- Ondřej Guth, Jan Holub (gar.), Tomáš Bartoň, Petr Hodač, Vojtěch Jirkovský, Radomír Polách, Ivan Ryant, Tomáš Řehořek, Martin Šlapák, Jan Trávníček
- 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. 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:
- https://edux.fit.cvut.cz/courses/BI-TED/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 Tue Fri Thu Fri - The course is a part of the following study plans:
-
- Computer Science, Version for Students who Enrolled in 2009 and 2010, Presented in Czech (compulsory course in the program)
- Computer engineering, Version for Students who Enrolled in 2009 and 2010, in Czech (compulsory course in the program)
- Software Engineering, Version for Students who Enrolled in 2009 and 2010, in Czech (compulsory course in the program)
- Web and Multimediac, Version for Students who Enrolled in 2009 and 2010, Presented in Czech (compulsory course in the program)
- Information Systems and Management, Version for Students who Enrolled in 2009 and 2010, in Czech (compulsory course in the program)
- Information Technology, Version for Students who Enrolled in 2009 and 2010, Presented in Czech (compulsory course in the program)
- Informatics, Version for Students who Enrolled in 2009 and 2010, Presented in Czech (compulsory course in the program)
- Informatics (Bachelor)- Version for those who Enrolled in 2011 and 2012 (in Czech) (compulsory course in the program)
- Information Systems and Management - Version for those who Enrolled in 2011 and 2012 (in Czech) (compulsory course in the program)
- Information Technology- Version for those who Enrolled in 2011 and 2012 (in Czech) (compulsory course in the program)
- Computer Engineering, Version for those who Enrolled in 2011 and 2012, in Czech (compulsory course in the program)
- Software Engineering- Version for those who Enrolled in 2011 and 2012 (in Czech) (compulsory course in the program)
- Computer Science - Version for those who Enrolled in 2011 and 2012 (in Czech) (compulsory course in the program)
- Web and Multimedia- Version for those who Enrolled in 2011 and 2012 (in Czech) (compulsory course in the program)