450-2083/01 – 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 | Czech |
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
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
Occurrence in study plans
Occurrence in special blocks
Assessment of instruction