450-2083/02 – Creation of Technical and Professional Documentation (TTOD)
| Gurantor department | Department of Cybernetics and Biomedical Engineering | Credits | 2 |
| Subject guarantor | Ing. Daniel Barvík, Ph.D. | Subject version guarantor | Ing. Daniel Barvík, Ph.D. |
| Study level | undergraduate or graduate | Requirement | Compulsory |
| Year | 2 | Semester | winter |
| | Study language | English |
| Year of introduction | 2019/2020 | Year of cancellation | |
| Intended for the faculties | FEI | Intended for study types | Bachelor |
Subject aims expressed by acquired skills and competences
The aim of the course is comprehensive preparation of students in creating technical and professional documentation. It is a foundation for technical subjects and will enable an understanding of the description of machine components and simple assemblies, electrical and mechanical drawings. In summary, the teaching is directed to the creation of technical and textual documentation as a comprehensive technical report according to standards.
Teaching methods
Lectures
Individual consultations
Tutorials
Summary
The course introduces students to the essential basics of technical and professional documentation and how to use them in the creation of professional text messages. The creation of professional text messages includes component and assembly drawings, electrical schematics, documentation and documentation for the manufacture of printed circuit boards, including the text section. In practice, graduates will become familiar with drawing technical drawings, electrical schematics and other objects. Explanation of the creation of technical documentation is presented in accordance with the standardization of documents (ISO, EN, IEC, CSN). The meaning and creation of technical documentation is shown and practically practiced on comprehensive text documents that contain technical and electrical diagrams, flowcharts, schematics, graphs, tables, notes and their drafting into units, including the insertion of references to literature and bookmarks in the text. It also explains the creation of literature references and their use according to current standards. Students are also introduced to circuit board design along with the basics of 3D modelling. The course also introduces students to software documentation and versioning using Git.
Compulsory literature:
Recommended literature:
Additional study materials
Way of continuous check of knowledge in the course of semester
Interim study check: two interim tests and a report. Conditions for the award of credit: two tests of intermediate control with a maximum of 20 points each and the preparation of a professional report - a maximum of 60 points. Total max. 100 points, min. 51 points. For the award of credit, compulsory attendance at the exercises is required for at least 80% of the class hours.
E-learning
Materials are available at https://lms.vsb.cz/?lang=en
Other requirements
Průběžná kontrola studia: dva testy průběžné kontroly a referát. Podmínky udělení zápočtu: dva testy průběžné kontroly max. po 20 bodech a zpracování odborného referátu - max. 60 bodů. Celkem max. 100 bodů, min. 51 bodů. Pro udělení zápočtu je vyžadována povinná účast na cvičeních minimálně 80% z proběhlých vyučovacích hodin.
Prerequisities
Subject has no prerequisities.
Co-requisities
Subject has no co-requisities.
Subject syllabus:
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.
Conditions for subject completion
Occurrence in study plans
Occurrence in special blocks
Assessment of instruction
Předmět neobsahuje žádné hodnocení.