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

Gurantor departmentDepartment of Cybernetics and Biomedical EngineeringCredits2
Subject guarantorIng. Daniel Barvík, Ph.D.Subject version guarantorIng. Daniel Barvík, Ph.D.
Study levelundergraduate or graduateRequirementCompulsory
Year2Semesterwinter
Study languageCzech
Year of introduction2019/2020Year of cancellation
Intended for the facultiesFEIIntended for study typesBachelor
Instruction secured by
LoginNameTuitorTeacher giving lectures
BAR0420 Ing. Daniel Barvík, Ph.D.
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+2
Part-time Graded credit 0+8

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:

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.

Additional study materials

Way of continuous check of knowledge in the course of semester

Conditions for credit: Credit test max. 40 points (minimum 21 points) and preparation of technical documentation - max. 60 points (minimum 30 points). Total max. 100 points, min. 51 points. For credit to be awarded, attendance at a minimum of 80% of the class hours is required.

E-learning

Other requirements

Projects: each student will be assigned one major project to work on during the semester.

Prerequisities

Subject has no prerequisities.

Co-requisities

Subject has no co-requisities.

Subject syllabus:

Lectures: 1. Introduction to technical documentation, standardization (ISO, EN, IEC, CSN), types of documents, content structure. 2. 2. Selection of document templates, working with patterns, drawing electrical and mechanical drawings and schematic figures. Creating flow charts. Working with and editing patterns, inserting images and their description. 3. Databases of books, journals and scientific communications. Meaning, principle of organization and publication. Method of information retrieval and creation of citation references according to standards. Citation software and citation references. 4. Electrical documentation, basic types, marks, connections, types of lines. 5. Drawing creation, stamp editing, scale, ruler, drawing simple mechanical drawings, quotation. 6. Familiarity with Latex for creating professional technical documentation. 7. Technical documentation and software versioning using Git. Computer exercises: 1. Introduction to technical documentation, standardization (ISO, EN, IEC, CSN), document types, content structure. 2. Vector and raster graphics, creation of vector images, drawing block diagrams. 3. Searching for professional technical communications, storing them in a database and creating citation lists. Linking citation editors with MS Word. 4. Electrical documentation, basic types, marks, connections, line types. 5. Drawing creation, stamp editing, scale, ruler, drawing simple mechanical drawings, quotation. 6. Drawing electronic circuit diagram of bio-amplifier. 7. Design of circuit board layout as per bio-amplifier circuit diagram. 8. Preparation of manufacturing data, export of GERBER files, creation of copper layer drawings, assembly plan. 9. Introduction to 3D modelling, creation of a model to fit the designed PCB. Body cuts. 10. Technical drawing of 3D model of circuit board packaging, types of views, dimension tolerances, material type, export of 3D object. 11. Electrical diagram of the house installation, marking of wires and terminals. 12. Practical demonstration of software versioning using Git tool.

Conditions for subject completion

Part-time form (validity from: 2019/2020 Winter semester, validity until: 2024/2025 Summer 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
        Odborný referát s praktickými úkoly Semestral project 60  30 1
        1. Průběžný test Written test 20  10 2
        2. Průběžný 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 yearProgrammeBranch/spec.Spec.ZaměřeníFormStudy language Tut. centreYearWSType of duty
2025/2026 (B0714A060016) Biomedical Technology P Czech Ostrava 2 Compulsory study plan
2025/2026 (B0714A060016) Biomedical Technology K Czech Ostrava 2 Compulsory study plan
2025/2026 (B0714A060018) Biomedical Assistive Technology P Czech Ostrava 2 Choice-compulsory type B study plan
2024/2025 (B0714A060018) Biomedical Assistive Technology K Czech Ostrava 2 Choice-compulsory type B study plan
2024/2025 (B0714A060018) Biomedical Assistive Technology P Czech Ostrava 2 Choice-compulsory type B study plan
2024/2025 (B0714A060016) Biomedical Technology P Czech Ostrava 2 Compulsory study plan
2024/2025 (B0714A060016) Biomedical Technology K Czech Ostrava 2 Compulsory study plan
2023/2024 (B0714A060016) Biomedical Technology P Czech Ostrava 2 Compulsory study plan
2023/2024 (B0714A060016) Biomedical Technology K Czech Ostrava 2 Compulsory study plan
2023/2024 (B0714A060018) Biomedical Assistive Technology P Czech Ostrava 2 Choice-compulsory type B study plan
2023/2024 (B0714A060018) Biomedical Assistive Technology K Czech Ostrava 2 Choice-compulsory type B study plan
2022/2023 (B0714A060016) Biomedical Technology K Czech Ostrava 2 Compulsory study plan
2022/2023 (B0714A060016) Biomedical Technology P Czech Ostrava 2 Compulsory study plan
2022/2023 (B0714A060018) Biomedical Assistive Technology P Czech Ostrava 2 Choice-compulsory type B study plan
2022/2023 (B0714A060018) Biomedical Assistive Technology K Czech Ostrava 2 Choice-compulsory type B study plan
2021/2022 (B0714A060016) Biomedical Technology K Czech Ostrava 2 Compulsory study plan
2021/2022 (B0714A060016) Biomedical Technology P Czech Ostrava 2 Compulsory study plan
2021/2022 (B0714A060018) Biomedical Assistive Technology P Czech Ostrava 2 Choice-compulsory type B study plan
2021/2022 (B0714A060018) Biomedical Assistive Technology K Czech Ostrava 2 Choice-compulsory type B study plan
2020/2021 (B0714A060016) Biomedical Technology K Czech Ostrava 2 Compulsory study plan
2020/2021 (B0714A060016) Biomedical Technology P Czech Ostrava 2 Compulsory study plan
2020/2021 (B0714A060018) Biomedical Assistive Technology K Czech Ostrava 2 Choice-compulsory type B study plan
2020/2021 (B0714A060018) Biomedical Assistive Technology P Czech Ostrava 2 Choice-compulsory type B study plan
2019/2020 (B0714A060016) Biomedical Technology P Czech Ostrava 2 Compulsory study plan
2019/2020 (B0714A060016) Biomedical Technology K Czech Ostrava 2 Compulsory study plan

Occurrence in special blocks

Block nameAcademic yearForm of studyStudy language YearWSType of blockBlock owner

Assessment of instruction



2024/2025 Winter
2023/2024 Winter
2022/2023 Winter
2021/2022 Winter
2020/2021 Winter