420-2028/01 – Documentation Creation (TD)

Gurantor departmentDepartment of Electrical EngineeringCredits4
Subject guarantorIng. Tomáš Mlčák, Ph.D.Subject version guarantorIng. Tomáš Mlčák, Ph.D.
Study levelundergraduate or graduateRequirementCompulsory
Year1Semestersummer
Study languageCzech
Year of introduction2016/2017Year of cancellation
Intended for the facultiesFEIIntended for study typesBachelor
Instruction secured by
LoginNameTuitorTeacher giving lectures
KOL62 doc. Ing. Václav Kolář, Ph.D.
MLC37 Ing. Tomáš Mlčák, Ph.D.
Extent of instruction for forms of study
Form of studyWay of compl.Extent
Full-time Graded credit 2+2

Subject aims expressed by acquired skills and competences

The aim is to get an idea of the importance of technical documentation as an international means of communication of technicians. The aim is also to develop the imagination of technicians, logic and creative thinking of students. Graduates acquire basic knowledge and skills to read, use and creation of technical documentation and also learn to express their ideas graphically. They get acquainted with leading software systems for the creation of project technical documentation in accordance with applicable laws and regulations.

Teaching methods

Lectures
Tutorials
Experimental work in labs

Summary

Technical documentation is a means of applicable to communication the result specific activities for wide range of people, mainly workers of development, research, design, construction, production, including the use of ordinary users of the device. The connecting links to enable an understanding of the technical documentation for a wide range of workers are agreed signs, symbols, descriptions, rules for the use, creation and drawing diagrams and terminology contained in the standards. It's actually documentation of information and of activities for all participants realized project. The reason for the introduction of uniform technical terminology is intelligibility and clarity of interpretation. A means for its implementation are of international standards, including technical terms and definitions in several languages.

Compulsory literature:

J. C. Whitaker, R. K. Mancini: Technical Documentation and Process, CRC Press, 2012

Recommended literature:

A. J. Marlow: Technical Documentation, Blackwell Publishers; 1995

Way of continuous check of knowledge in the course of semester

During the semester students' knowledge will be verified through a short test on the given topics. At the end of the semester students will write class exam.

E-learning

Další požadavky na studenta

Additional requirements for students are not.

Prerequisities

Subject has no prerequisities.

Co-requisities

Subject has no co-requisities.

Subject syllabus:

1. Introduction to technical standardization. Legislation and Standards. 2. Division of technical documentation. Types of drawings technical documentation. 3. Definitions of terms used in technical documentation relating to technical drawings, product definition and related documentation in all areas of application. 4. Sorting, labelling and standards for the documentation used in electrical engineering. 5. Structuring principles and reference designations. Rules and instructions for the formulation of unambiguous reference designations object in any system. 6. Principles making of documents used in electro technology. 7. Software systems for the generation of project documentation. 8. Reading, creation and management of project documentation in the system Engineering Base. 9. Reading, creation and management of project documentation in the system EPLAN P8. 10. Creation of graphical symbols for use in technical documentation, graphical symbols used in diagrams and drawings in electrical engineering, electro technical schemes. 11. Electrical technical documentation for realization of buildings. Project documentation for electrical installations under the Building Act. 12. Technical documentation of machinery. 13. Technical documents in terms of the creation, use and termination of the product and its place in the life cycle of the product. 14. Technical documentation for the design of software components. The accompanying documentation. Technical documentation for maintenance. Protection of ownership documents.

Conditions for subject completion

Full-time form (validity from: 2016/2017 Winter semester)
Task nameType of taskMax. number of points
(act. for subtasks)
Min. number of points
Graded credit Graded credit 100  51
Mandatory attendence parzicipation:

Show history

Occurrence in study plans

Academic yearProgrammeField of studySpec.FormStudy language Tut. centreYearWSType of duty
2019/2020 (B2660) Computer Systems for the Industry of the 21st. Century P Czech Ostrava 1 Compulsory study plan
2018/2019 (B2660) Computer Systems for the Industry of the 21st. Century P Czech Ostrava 1 Compulsory study plan
2017/2018 (B2660) Computer Systems for the Industry of the 21st. Century P Czech Ostrava 1 Compulsory study plan
2016/2017 (B2660) Computer Systems for the Industry of the 21st. Century P Czech Ostrava 1 Compulsory study plan

Occurrence in special blocks

Block nameAcademic yearForm of studyStudy language YearWSType of blockBlock owner