Skip to main content
Skip header

Creation of Technical and Professional Documentation

* Exchange students do not have to consider this information when selecting suitable courses for an exchange stay.

Course Unit Code450-2083/01
Number of ECTS Credits Allocated2 ECTS credits
Type of Course Unit *Compulsory
Level of Course Unit *First Cycle
Year of Study *Second Year
Semester when the Course Unit is deliveredWinter Semester
Mode of DeliveryFace-to-face
Language of InstructionCzech
Prerequisites and Co-Requisites Course succeeds to compulsory courses of previous semester
Name of Lecturer(s)Personal IDName
OCZ0005Ing. David Oczka, Ph.D.
BAR0420Ing. Daniel Barvík, Ph.D.
Summary
Learning outcomes of the course unit The subject acquaints students with the essential basics of technical and professional documentation and the way they are used in the creation of professional text messages. The creation of expert text messages includes drawings of components and assemblies, diagrams in electrical engineering, documentation and substrates for the manufacture of printed circuit boards, including the text part. Practically graduates will be acquainted with the drawing of technical drawings, electrotechnical schemes and other objects. Explanation of the production of the technical documentation is presented in accordance with document standardization (ISO, EN, IEC, ETS, ČSN). The meaning and creation of the technical documentation is illustrated and practiced on practically comprehensive text documents, which include technical and electrotechnical diagrams, flowcharts, diagrams, graphs, tables, notes and their conception in totals including insertion of references to literature and bookmarks in the text. It also explains the creation of literary references and their use according to valid standards. Students will also get acquainted with the presentation of the expert texts. Skills training is directed to computer support for documentation creation using MS Office.
Learning Outcomes of the Course Unit
Learning outcomes of the course unit The aim of the course is to prepare students in the preparation of technical and technical documentation using MS Office tools. It is the basis for specialized subjects and will enable the understanding of the description of machine parts and simple assemblies, electrotechnical and machine drawings. In summary, the course is aimed at creating expert and text documentation as a comprehensive expert report according to the standards.
Course Contents
Lectures:
1. Introduction to the organization of the hospital, the position of employees and their role in the system. Structure of hospital departments and their hierarchy. Objectives and methods of training and verification of studies. Relationship of education in terms of laws, legislation and professional documentation.
2. Technical documentation as a tool for communication to the professional community. Communication of knowledge and experience and their purpose and objectives. Classification and types of documents, standardisation (ISO, EN, IEC, ETS, CSN). Importance of graphical and textual information.
3. Publication of a communication or technical report, types of documents, structure of content. Publication in a book, journal, proceedings. The essence of intellectual property protection and its documentation. Overview of classification and cataloguing. Copyright law and a selection of standards for the creation of textual documentation.
4. Graphic editors and creation of image documentation. Selecting document templates, working with patterns, drawing electrical and mechanical drawings and schematic figures. Creation of flow and contingency diagrams. Working with and editing figures, layers and their use, inserting figures and their description. Graphical outputs for printing and use of export functions
5. Spreadsheets. Basic spreadsheet environment creating tables, entering mathematical expressions, addressing cells, creating and describing a chart.
6. Text editors - document style and template, formats, fonts, paragraphs and pages. Working with text styles. Inserting and numbering images, tables, graphs and equations. Cross-referencing, citing literature. Creating sections of a text document and their use. Creation of table of contents and automatic lists.
7. Databases of books, journals and scientific communications. Purpose, principle of organization and publication. Method of information retrieval and creation of citation references according to standards. Citation software and citation referencing.
8. Creation of drawings and pictorial documentation using graphical word processing software. Creating outlines, using formatting and styles, inserting graphic and tabular documentation. Inserting links, links and bookmarks. How to list and cite literature in the text
9. Presentation of technical documentation and technical communication in MS Power Point environment. Working with a template. Common ways of creating presentations. Animation, insertion of images, tables, graphs and videos. Exporting presentations.
10. Introduction to technical drawing and creating technical drawing format. Standardization in technical drawing and methods of technical representation, meaning of standardization, use of scale and types of lines. Technical handwriting and template based technical drawing. Diameters on three perpendicular projections for simple and compound solids. Use of sections and cross-sections, intersections of solids.
11. Dimension, shape and position tolerances, surface finish and material type. Quotations for geometric and structural elements and their components, determination of permissible deviations of dimensions, shape and position. Determination and prescription of the quality and surface finish of components.
12. Drawings of machine components and connections and their creation and reading. Methods of marking mechanical connections. Drawing of component drawings and simple assemblies.
13. Electrical documentation creation and reading of electrical schematics. Overview diagrams, circuit diagrams, internal wiring diagrams, line diagrams, situation diagram.
14. Electrical documentation creation of electrical schematics. Basic types of schematics, schematic and block markings, patterns and connections. Marking of wires and terminals.


Computer exercises:
1. Creating and working with a graphic editor - drawing lines, patterns and given diagrams and patterns, creating groups of elements, editing patterns, filling, operations with patterns, lines inserting pictures.
2. Drawing flow charts and contingency patterns.
3. Drawing creation, stamp editing, scale, ruler, drawing simple machine drawings, dimensioning.
4. Working with and editing patterns, layers and their use, inserting figures and their description. Graphical output for printing and use of export functions.
5. Working with MS Excel spreadsheet editor creating tables, inserting formulas operations with cells, Creating graphs, descriptions of graphs, Print settings.
6. Working with MS Word word processor - document style and template, formats, fonts, paragraphs and pages, inserting and numbering images, tables, graphs and equations, creating sections, automatic lists.
7. Working with MS Word word processor - inserting graphics and tables. Inserting links, links and bookmarks. Creating a reference list and citing it in the text.
8. Searching for professional technical communications, storing them in a database and creating citation lists. Linking citation editors to MS Word.
9. Implementation of technical communication in MS PowerPoint environment. Templates and their editing, Inserting images, texts, tables and graphs.
10. Drawing drawings - Use of scale and line types. Technical handwriting and template-based writing. Averages on three perpendicular projections for simple and compound solids. Use of sections and cross sections, intersections of solids.
11. Use of dimensioning for geometric and structural elements and their components, determination of permissible deviations of dimensions, shape and position.
12. Drawing of components and simple assemblies.
13. Drawing and creating electrical schematics.
14. Drawing and training for schematic and block markings, patterns and connections, marking of wires and terminals.
Recommended or Required Reading
Required Reading:
NOVÁK, František a Ivana LINKEOVÁ. Technical documentation. Praha: Vydavatelství ČVUT, 2004. ISBN 80-01-03040-7.
KŘIVÝ, Jaroslav a Jaroslav POSPÍCHAL. Fundamentals of design: technical drawing and dimensioning. Praha: České vysoké učení technické, 1997. ISBN 80-01-01600-5.
DRASTÍK, František. Tvorba technické dokumentace. V Praze: České vysoké učení technické, 2012. ISBN 978-80-01-05058-3.
ŠŤASTNÝ, Jiří a Boleslav TŘEŠTÍK. Manuál technické dokumentace. 6., přeprac. vyd. České Budějovice: Česká matice technická v nakl. Kopp, 2009. Česká matice technická (Kopp). ISBN 978-80-7232-352-4.
KONEČNÝ, Zdeněk. Základy technické dokumentace. Ostrava: Vysoká škola báňská - Technická univerzita, 2004. ISBN 80-248-0514-6.
SATINSKÝ, Alexej. Lexikon elektrotechnika: elektrotechnické značky. Havířov: Iris, c2004. ISBN 80-903540-2-5.
SLANAŘ, Václav. Technické kreslení. 2. upr. a dopl. vyd. Písek: J & M, 1999. Učebnice technického kreslení. ISBN 80-86154-16-5.
DRASTÍK, František. Technické kreslení podle mezinárodních norem I.: pravidla tvorby výkresů ve strojírenství. Ostrava: Montanex, 1998. ISBN 80-7225-013-2.
TOMAN, Josef. Technické kreslení podle ČSN a mezinárodních norem. Ostrava: Montanex, 1995. ISBN 80-85780-27-5.
POLÁČEK, Dušan. Technické kreslení podle mezinárodních norem: pravidla tvorby výkresů a schémat v elektronice. Praha: Montanex, 1995. ISBN 80-85780-28-3.
ČERVENKA, Petr a Richard VELIČKA. Základy použití počítačů pro BMT[online]. Ostrava: Vysoká škola báňská, 2007 [cit. 2017-11-25]. ISBN 978-80-248-1287-8.
HLAVÁČ, Vladimír, Růžena PETROVÁ a Bohumil ŠULC. Základy použití počítačů: počítačem podporované zpracování dokumentů [online]. Vyd. 2. přeprac. Praha: Vydavatelství ČVUT, 2003 [cit. 2017-11-25]. ISBN 80-01-02796-1.
ŠULC, Bohumil, Vladimír HLAVÁČ a Růžena PETROVÁ. Základy použití počítačů: počítačem podporované zpracování technických dokumentů [online]. Praha: Vydavatelství ČVUT, 1999 [cit. 2017-11-25]. ISBN 80-01-02033-9.
FARANA, Radim. Doporučení pro psaní odborných textů z oblasti automatizace a informatiky. Ostrava: VŠB - Technická univerzita Ostrava, 2008. ISBN 978-80-248-1925-9.
Úprava písemností psaných strojem nebo zpracovaných textovými editory: ČSN 01 6910. Praha: Český normalizační institut, 1997. ČSN, 01 6910.
NOVÁK, František a Ivana LINKEOVÁ. Technical documentation. Praha: Vydavatelství ČVUT, 2004. ISBN 80-01-03040-7.
KŘIVÝ, Jaroslav a Jaroslav POSPÍCHAL. Fundamentals of design: technical drawing and dimensioning. Praha: České vysoké učení technické, 1997. ISBN 80-01-01600-5.
Recommended Reading:
INCROPERA, Frank P. Fundamentals of heat and mass transfer: software tools and user's guides. 5 ed. New York: John Wiley, 2002. ISBN 0-471-07588-4.
DUFFY, Jennifer A. a Carol M. CRAM. Microsoft Word 2010. Australia: Course Technology, Cengage Learning, 2011. ISBN 0538748346.
Walkenbach, J.: Microsoft Excel 2000 Formulas, IDG Books Worlwide. *M&T Press; Pap/Cdr edition, 1999. ISBN-13: 978-0764546099.
SLAVATA, Petr. AutoCAD: verze 2004 česká : tvorba 2D technické dokumentace. České Budějovice: Kopp, 2003. ISBN 80-7232-211-7
BILÍK, Petr. Základy použití počítačů [online]. Ostrava: VŠB-Technická univerzita, 1995 [cit. 2017-11-25]. ISBN 80-7078-283-8.
BROŽA, Petr. Bible Microsoft Office 2007. Brno: Extra Publishing, 2007. Bestseller (Extra Publishing).
PECINOVSKÝ, Josef. Microsoft Office 2013: podrobná uživatelská příručka. Brno: Computer Press, 2013. ISBN 978-80-251-4102-1.
KUBÁLEK, Tomáš, Markéta KUBÁLKOVÁ a Ivana TOPOLOVÁ. Microsoft Office 365: systém sjednocené komunikace. Brno: Tribun EU, 2012. Manažerská informatika. ISBN 978-80-263-0245-2.
Úprava písemností zpracovaných na PC podle platných norem. Praha: Dashöfer, 2008. ISSN 1803-5531.
KULDOVÁ, Olga. Normalizovaná úprava písemností psaných strojem nebo zpracovaných textovým editorem: komentovaná norma s ukázkami. Praha: Fortuna, 1999. ISBN 80-7168-656-5.
PUSTKA, Zdeněk. Základy konstruování: (tvorba technické dokumentace). Vyd. 3. Liberec: Technická univerzita v Liberci, 2007. ISBN 978-80-7372-270-8.
Elektrotechnická dokumentace podle ČSN a mezinárodních norem: (schémata, značky, automatizované kreslení, databanky). Plzeň: Dům techniky ČSVTS, 1990.
Planned learning activities and teaching methods
Lectures, Individual consultations, Tutorials
Assesment methods and criteria
Task TitleTask TypeMaximum Number of Points
(Act. for Subtasks)
Minimum Number of Points for Task Passing
Graded creditGraded credit100 (100)51
        Odborný referát s praktickými úkolySemestral project60 30
        1. Průběžný testWritten test20 10
        2. Průběžný testWritten test20 10