Navigation

OE4TD - Technical Documentation

Course specification
Course title Technical Documentation
Acronym OE4TD
Study programme Electrical Engineering and Computing
Module Electronics
Type of study bachelor academic studies
Lecturer (for classes)
Lecturer/Associate (for practice)
Lecturer/Associate (for OTC)
    ESPB 2.0 Status elective
    Condition non
    The goal To train students to keep personal and business technical documentations.
    The outcome To train students to keep personal and business technical documentations.
    Contents
    Contents of lectures Notion and types of technical documentations. Personal documentations, archive documentations, lab notebook. Business documentations, types and usage. Idea documentations, specification of users’ demands, specification of needed resources. Implementation project, management plan, specification supplement. Development research, documentation of construction and development of a final product.
    Contents of exercises Production documentation, specification of materials, mechanical and electro - magnetic specifications, specifications of product finishing. Specification of implementations and testing results. User documentations, user – usage manual, maintenance manual, a detailed description of functioning from a view of a user. Service manual. Software tools.
    Literature
    1. Paula Bell, Charlotte Evans: “Mastering Documentation”, John wiley & Sons, New York, 1989. (Original title)
    2. V. Stibić: “Personal Documentation for Professionals – Means and Methods”, North-Holland Publ. Co., Amsterdam, 1980 (Original title)
    Number of hours per week during the semester/trimester/year
    Lectures Exercises OTC Study and Research Other classes
    0 2 0
    Methods of teaching demonstration, discussion, projects
    Knowledge score (maximum points 100)
    Pre obligations Points Final exam Points
    Activites during lectures 0 Test paper 30
    Practical lessons 0 Oral examination 0
    Projects 70
    Colloquia 0
    Seminars 0