450-2083/02 – Creation of Technical and Professional Documentation (TTOD)

Gurantor departmentDepartment of Cybernetics and Biomedical EngineeringCredits2
Subject guarantorIng. David Oczka, Ph.D.Subject version guarantorIng. David Oczka, Ph.D.
Study levelundergraduate or graduateRequirementCompulsory
Year2Semesterwinter
Study languageEnglish
Year of introduction2019/2020Year of cancellation
Intended for the facultiesFEIIntended for study typesBachelor
Instruction secured by
LoginNameTuitorTeacher giving lectures
OCZ0005 Ing. David Oczka, Ph.D.
PEN72 prof. Ing. Marek Penhaker, Ph.D.
VEL25 Ing. Richard Velička, Ph.D.
Extent of instruction for forms of study
Form of studyWay of compl.Extent
Full-time Graded credit 1+1
Part-time Graded credit 0+8

Subject aims expressed by acquired skills and competences

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.

Teaching methods

Lectures
Individual consultations
Tutorials

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.

Compulsory literature:

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 literature:

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.

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

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

Full-time form (validity from: 2019/2020 Winter semester)
Task nameType of taskMax. number of points
(act. for subtasks)
Min. number of pointsMax. počet pokusů
Graded credit Graded credit 100 (100) 51 3
        Technical review with practical tasks Semestral project 60  30 1
        1. Control test Written test 20  10 2
        2. Control test Written test 20  10 2
Mandatory attendence participation: Assesment methods and criteria linked to learning outcomes: Attendance at seminars requires at least 80% of the taught lessons.

Show history

Conditions for subject completion and attendance at the exercises within ISP: Completion of all mandatory tasks within individually agreed deadlines.

Show history

Occurrence in study plans

Academic yearProgrammeField of studySpec.ZaměřeníFormStudy language Tut. centreYearWSType of duty
2023/2024 (B0714A060017) Biomedical Technology P English Ostrava 2 Compulsory study plan
2023/2024 (B0714A060019) Biomedical Assistive Technology P English Ostrava 2 Choice-compulsory type B study plan
2022/2023 (B0714A060017) Biomedical Technology P English Ostrava 2 Compulsory study plan
2022/2023 (B0714A060017) Biomedical Technology K English Ostrava 2 Compulsory study plan
2022/2023 (B0714A060019) Biomedical Assistive Technology P English Ostrava 2 Choice-compulsory type B study plan
2021/2022 (B0714A060017) Biomedical Technology P English Ostrava 2 Compulsory study plan
2021/2022 (B0714A060017) Biomedical Technology K English Ostrava 2 Compulsory study plan
2021/2022 (B0714A060019) Biomedical Assistive Technology P English Ostrava 2 Choice-compulsory type B study plan
2020/2021 (B0714A060017) Biomedical Technology K English Ostrava 2 Compulsory study plan
2020/2021 (B0714A060017) Biomedical Technology P English Ostrava 2 Compulsory study plan
2020/2021 (B0714A060019) Biomedical Assistive Technology P English Ostrava 2 Choice-compulsory type B study plan
2019/2020 (B0714A060017) Biomedical Technology P English Ostrava 2 Compulsory study plan
2019/2020 (B0714A060017) Biomedical Technology K English Ostrava 2 Compulsory study plan

Occurrence in special blocks

Block nameAcademic yearForm of studyStudy language YearWSType of blockBlock owner

Assessment of instruction

Předmět neobsahuje žádné hodnocení.