Provide technical documentation

Prepare documentation for existing and upcoming products or services, describing their functionality and composition in such a way that it is understandable for a wide audience without technical background and compliant with defined requirements and standards. Keep documentation up to date.

document the product life cycle
prepare technical documentation

skill/competence

cross-sector

Provide technical documentation is an essential skill of the following occupations:

Integration engineer: Integration engineers develop and implement solutions which coordinate applications across the enterprise or its units and departments. They evaluate existing components or systems to determine integration requirements and ensure that the final solutions meet organisational needs. They reuse components when possible and assist management in taking decisions. They perform ICT system integration troubleshooting.
Refurbishing technician: Refurbishing technicians overhaul and refurbish inner parts of vehicles, such as engine parts and diesel pumps.
Rotating equipment engineer: Rotating equipment engineers develop designs and specifications for rotating equipment according to any applicable standards. They also provide technical expertise and help ensure that all new and existing equipment installations are completed.
Communication infrastructure maintainer: Communication infrastructure maintainers install, repair, run and maintain infrastructure for communication systems.
ICT application configurator: ICT application configurators identify, record, and maintain user-specific application configurations based upon user requirements and business rules. They configure generic software systems in order to create a specific version applied to an organisation’s context. These configurations range from adjusting basic parameters through the creation of business rules and roles in the ICT system to developing specific modules (including the configuration of Commercial off-the-shelf systems (COTS)). They also document configurations, perform configuration updates, and ensure the configurations are correctly implemented in the application.
Packing machinery engineer: Packing machinery engineers are in charge of and responsible for packaging machinery. They maintain and improve technical standards, analyse results, set up improvement plans, and are responsible for machinery maintenance.
Embedded systems software developer: Embedded systems software developers program, implement, document and maintain software to be run on an embedded system.
ICT network technician: ICT network technicians install, maintain and troubleshoot networks, data communications equipment and network installed devices such as printers and storage area networks. They also analyse and fix network-related problems reported by users.
ICT research consultant: ICT research consultants perform targeted ICT research and provide a final report to the client. They also use ICT tools to design questionnaires for surveys, analyse the results, write reports, present the results and make recommendations based on the research findings.
Ethical hacker: Ethical hackers perform security vulnerability assessments and penetration tests in accordance with industry-accepted methods and protocols. They analyse systems for potential vulnerabilities that may result from improper system configuration, hardware or software flaws, or operational weaknesses.
Fluid power engineer: Fluid power engineers supervise the assembly, installation, maintenance, and testing of fluid power equipment in accordance with specified manufacturing processes. They create designs with schematics and assembly models, make drawings and bills of materials for components, and analyse equipment.
ICT network administrator: ICT network administrators maintain operation of a reliable, secure, and efficient data communications network, including LAN, WAN, intranet, and internet. They perform network address assignment, management and implementation of routing protocols such as ISIS, OSPF, BGP, routing table configurations and certain implementations of authentication. They perform maintenance and administration of servers (file servers, VPN gateways, intrusion detection systems), desktop computers, printers, routers, switches, firewalls, phones, IP communications, personal digital assistants, smartphones, software deployment, security updates and patches as well as a vast array of additional technologies inclusive of both hardware and software.
Industrial tool design engineer: Industrial tool design engineers design various industrial tools in accordance with customer needs, manufacturing requirements, and building specifications. They test the designs, look for solutions to any problems, and oversee production.
Technical communicator: Technical communicators prepare clear, concise and professional communication from product developers to users of the products such as online help, user manuals, white papers, specifications and industrial videos. For this, they analyse products, legal requirements, markets, customers and users. They develop information and media concepts, standards, structures and software tool support. They plan the content creation and media production processes, develop written, graphical, video or other contents, generate media output, release their information products and receive feedback from the users.
Packaging production manager: Packaging production managers define and analyse package units in order to avoid damages or loss of quality of the goods packed. They also design the packaging according the specifications of the product and offer solutions to solve packaging problems.
Container equipment design engineer: Container equipment design engineers design equipment to contain products or liquids, according to set specifications, such as boilers or pressure vessels. They test the designs, look for solutions to any problems and oversee production.
Data centre operator: Data centre operators maintain computer operations within the data centre. They manage daily activities within the centre to solve problems, maintain the system availability, and evaluate the system’s performance.
ICT system administrator: ICT system administrators are responsible for the upkeep, configuration, and reliable operation of computer and network systems, servers, workstations and peripheral devices. They may acquire, install, or upgrade computer components and software; automate routine tasks; write computer programs; troubleshoot; train and supervise staff; and provide technical support. They ensure optimum system integrity, security, backup and performance.
ICT security technician: ICT security technicians propose and implement necessary security updates and measures whenever is required. They advise, support, inform and provide training and security awareness.
Agricultural equipment design engineer: Agricultural equipment design engineers apply knowledge of engineering and biological science to solve various agricultural problems such as soil and water conservation and the processing of agricultural products. They design agricultural structures, machinery, equipment and processes.
ICT system developer: ICT system developers maintain, audit and improve organisational support systems. They use existing or new technologies to meet particular needs. They test both hardware and software system components, diagnose and resolve system faults.
Industrial mobile devices software developer: Industrial mobile devices software developers implement applications software for specific, professional industrial mobile (handheld) devices, based on the industry needs, using general or specific development tools for device operating systems.
ICT application developer: ICT application developers implement the ICT (software) applications based on the designs provided using application domain specific languages, tools, platforms and experience.
Web developer: Web developers develop, implement and document web-accessible software based on the designs provided. They align the client’s web presence with its business strategy, troubleshoot software problems and issues and look for ways to improve the application.
ICT environmental manager: ICT environmental managers know the green ICT legal framework, understand the role of the ICT network configurations in the economy and energy resources deployment and evaluate the impact of CO2 footprint of each ICT resource in the organisation’s network. They plan and manage the implementation of environmental strategies for ICT networks and systems by conducting applied research, developing organisational policy, and devising strategies to meet sustainability targets. They ensure that the whole organisation uses ICT resources in a way that is as friendly as possible for the environment.

ICT network engineer: ICT network engineers implement, maintain and support computer networks. They also perform network modelling, analysis, and planning. They may also design network and computer security measures. They may research and recommend network and data communications hardware and software.
Software architect: Software architects create the technical design and the functional model of a software system, based on functional specifications. They also design the architecture of the system or different modules and components related to the business’ or customer requirements, technical platform, computer language or development environment.
ICT network architect: ICT network architects design the topology and connectivity of ICT network such as hardware, infrastructure, communication and hardware components.
Software developer: Software developers implement or program all kinds of software systems based on specifications and designs by using programming languages, tools, and platforms.
User experience analyst: User experience analysts assess client interaction and experience and analyse users’ behaviours, attitudes, and emotions about the usage of a particular product, system or service. They make proposals for the improvement of the interface and usability of products, systems or services. In doing so, they take into consideration the practical, experiential, affective, meaningful and valuable aspects of human–computer interaction and product ownership, as well as the person’s perceptions of system aspects such as utility, ease of use and efficiency, and user experience dynamics.

Provide technical documentation is optional for these occupations. This means knowing this skill may be an asset for career advancement if you are in one of these occupations.

Telecommunications engineer: Telecommunications engineers design, build, test and maintain telecommunication systems and networks, including radio and broadcasting equipment.
They analyse customer needs and requirements, ensure that the equipment meets regulations, and prepare and present reports and proposals on telecommunication-related problems. Telecommunications engineers design and oversee the service delivery in all it’s phases, supervising the installation and use of telecommunications equipment and facilities, preparing documentation and providing training for company staff once new equipment has been installed.
Fluid power technician: Fluid power technicians install and assemble equipment that uses liquid or gas pressure to transmit or regulate power. They also perform tests on and maintain this equipment.
Medical device engineer: Medical device engineers design and develop medical-technical systems, installations, and equipment such as pacemakers, MRI scanners, and X-ray machines. They monitor the whole manufacturing process from concept design to product implementation. activities undertaken include, among others, designing product improvements, developing methods and techniques to evaluate design suitability, coordinating initial production, developing test procedures, and designing manufacturing diagrams.
Embedded system designer: Embedded system designers translate and design requirements and the high-level plan or architecture of an embedded control system according to technical software specifications.
Quality services manager: Quality services managers manage the quality of services in business organisations. They ensure the quality of in-house company operations such as customer requirements and service quality standards. Quality services managers monitor the company’s performance and implement changes where necessary.
Electromechanical drafter: Electromechanical drafters draw and create blueprints together with electromechanical engineers. They interpret the specifications and requirements made by the engineer and design electromechanical equipment and components.
Electromagnetic engineer: Electromagnetic engineers design and develop electromagnetic systems, devices, and components, such as electromagnets in loudspeakers, electromagnetic locks, conducting magnets in MRI’s, and magnets in electric motors.
Pest management worker: Pest management workers identify, eliminate and repel pests by applying specific chemical solutions, setting traps and other equipment to control pests such as rats, mice and cockroaches. They apply pesticides and clean and remove pests after extermination. Their tasks might include elimination of fungi, moisture or insects. They inform and advise clients, residents and facility owners on after care and preventive methods to keep away pests.
Electrical drafter: Electrical drafters support engineers in the design and conceptualisation of electrical equipment. They draft, with the support of specialised software, the specifications of a varied number of electrical systems such as voltage transformers, power plants, or energy supply in buildings.
Industrial machinery mechanic: Industrial machinery mechanics work on new machinery and equipment in operation. They set up for the specific application and build accessories if necessary, perform maintenance and repair, and run diagnostics to find faults in systems or parts that need replacing.
Textile machinery technician: Textile machinery technicians set up, maintain, inspect and repair mechanical and computer-controlled machinery used in textile manufacturing such as weaving, dyeing and finishing machines.
 
Medical device engineering technician: Medical device engineering technicians collaborate with medical device engineers in the design, development and production of medical-technical systems, installations, and equipment such as pacemakers, MRI machines, and X-ray devices. They build, install, inspect, modify, repair, calibrate, and maintain medical-technical equipment and support systems. Medical device engineering technicians  are responsible for the operational readiness, safe use, economic operation and the appropriate procurement of medical equipment and facilities in hospitals.
Optoelectronic engineer: Optoelectronic engineers design and develop optoelectronic systems and devices, such as UV sensors, photodiodes, and LEDs. Optoelectronic engineering combines optical engineering with electronic engineering in the design of these systems and devices. They conduct research, perform analysis, test the devices, and supervise the research.
ICT technician: ICT technicians install, maintain, repair and operate information systems and any ICT related equipment (laptops, desktops, servers, tablets, smart phones, communications equipment, printers and any piece of computer related peripheral networks), and any type of software (drivers, operating systems, applications).
Sensor engineer: Sensor engineers design and develop sensors, sensor systems and products that are equipped with sensors. They plan and monitor the manufacture of these products.
Pneumatic systems technician: Pneumatic systems technicians use blueprints and technical documentation to assemble and install equipment operated by gas or air under pressure. They set up the systems according to engineering specifications and test them to ensure good functioning order. They may also perform maintenance and repair work on installed pneumatic equipment.
Industrial engineer: Industrial engineers design a vast array of production systems aiming to present efficient and effective solutions. They integrate a varied number of variables such as workers, technology, ergonomics, production flows, and product specifications for the design and implementation of production systems. They can specify and design for microsystems as well.
Military engineer: Military engineers perform technical and scientific functions in the military, such as the development of concepts for military technical equipment, support of the manufacturing of military equipment, and technical research, maintenance, and quality assurance.
Mechanical engineer: Mechanical engineers research, plan and design mechanical products and systems and supervise the fabrication, operation, application, installation and repair of systems and products. They research and analyse data.
Aquaculture production manager: Aquaculture production managers plan, direct and coordinate the production of fish, shellfish or other forms of aquatic life such as cash crops, in large-scale aquaculture operations to culture and harvest or for release into fresh, brackish or salt water. 

Forge equipment technician: Forge equipment technicians maintain and repair forge machinery such as presses and material handling equipment. They perform evaluations of the equipment, perform preventative maintenance activities, and repair faults. They also assist in the installation of the equipment and ensure proper functionality.
Moulding machine technician: Moulding machine technicians service machinery used in the casting and moulding of plastics and other materials. They calibrate the equipment, perform maintenance activities, examine finished products and repair faults.
Maintenance and repair engineer: Maintenance and repair engineers focus on the optimization of equipment, procedures, machineries and infrastructure. They ensure their maximum availability at minimum costs.
Computer-aided design operator: Computer-aided design operators use computer hardware and software in order to add the technical dimensions to computer aided design drawings. Computer-aided design operators ensure all additional aspects of the created images of products are accurate and realistic. They also calculate the amount of materials needed to manufacture the products. Later the finalised digital design is processed by computer-aided manufacturing machines that produce the finished product.
Numerical tool and process control programmer: Numerical tool and process control programmers develop computer programs to control automatic machines and equipment involved in manufacturing processes. They analyse blueprints and job orders, conduct computer simulations and trial runs.
Heating engineer: Heating engineers install and maintain gas, electric, oil, solid-fuel and multiple fuel heating and ventilation equipment as stand-alone heating and ventilation systems or build into machinery and transport equipment. They follow instructions and blueprints, perform maintance on systems, perform safety checks and repair the systems.
ICT auditor manager: ICT auditor managers monitor ICT auditors responsible for auditing information systems, platforms, and operating procedures in accordance with established corporate standards for efficiency, accuracy and security. They evaluate ICT infrastructure in terms of risk to the organisation and establish controls to mitigate loss. They determine and recommend improvements in the current risk management controls and in the implementation of system changes or upgrades.
ICT security manager: ICT security managers propose and implement necessary security updates. They advise, support, inform and provide training and security awareness and take direct action on all or part of a network or system.

Photonics engineer: Photonics engineers are concerned with the generation, transmission, transformation, and detection of light. They conduct research, design, assemble, test and deploy photonic components or systems in multiple application fields, from optical communications to medical instrumentation, material processing or sensing technology.
Electromechanical engineer: Electromechanical engineers design and develop equipment and machinery that use both electrical and mechanical technology. They make draughts and prepare documents detailing the material requisitions, the assembly process and other technical specifications. Electromechanical engineers also test and evaluate the prototypes. They oversee the manufacturing process.
Heating, ventilation, air conditioning (and refrigeration) service engineer: Heating, ventilation, air conditioning (and refrigeration) service engineers install and maintain industrial heating, air conditioning and possibly refrigeration systems. They set up furnaces, thermostats, ducts, vents, and other equipment needed to ensure the controlled passage and treatment of air. They also carry out repairs.
Microsystem engineer: Microsystem engineers research, design, develop, and supervise the production of microelectromechanical systems (MEMS), which can be integrated in mechanical, optical, acoustic, and electronic products.
User interface developer: User interface developers implement, code, document and maintain the interface of a software system by using front-end development technologies.
Electrical engineer: Electrical engineers design and develop electrical systems, electrical equipment, components, motors, and equipment with the feature of energy transmission. They engage in large scale projects such as the design and maintenance of power stations, and the distribution of power to smaller applications such as household appliances.
ICT project manager: ICT project managers schedule, control and direct the resources, people, funding and facilities to achieve the objectives of ICT projects. They establish budgets and timelines, perform risk analysis and quality management, and complete project closure reports.
Microelectronics engineer: Microelectronics engineers design, develop, and supervise the production of small electronic devices and components such as micro-processors and integrated circuits.
Database administrator: Database administrators test, implement and administer computer databases. They use their expertise in database management systems to plan, coordinate and implement security measures to safeguard computer databases. They also use scripts and configuration files to tailor a database to users’ needs.
Printed circuit board designer: Printed circuit board designers diagram and design the construction of circuit boards. They envision the logical placing of conductive tracks, coppers, and pin pads in the board. They use computer programmes and specialised software for the designs.
Computer hardware engineer: Computer hardware engineers design and develop computer hardware systems and components, such as circuit boards, modems, and printers. They draught blueprints and assembly drawings, develop and test the prototypes, and supervise the production process.
Manufactured wooden building assembler: Manufactured wooden building assemblers put together wooden elements for use in construction. The elements, or modules, may consist of walls with windows and doors built-in, or may be as large as whole rooms. The assemblers put together the supporting structure, insulation materials, and covering, and fasten it together to obtain usable modules.
Precision engineer: Precision engineers design processes, machines, fixtures and other equipment that have exceptionally low engineering tolerances, are repeatable and stable over time. They ensure prototypes are built and tested and make sure the designs meet system specifications and operational requirements.
Quality engineering technician: Quality engineering technicians work with quality engineers or managers to analyse and solve quality problems and improve productivity. They examine machines for imperfections and inspect products to make sure they meet the standards. They also provide personnel with training in inspection techniques and prepare inspection plans.
Digital games developer: Digital games developers program, implement and document digital games. They implement technical standards in gameplay, graphics, sound and functionality.
Drafter: Drafters prepare and create technical drawings using a special software or manual techniques, to show how something is built or works.
Mechatronics engineer: Mechatronics engineers design and develop intelligent systems, such as robotic devices, smart home appliances, and aeroplanes, through combining technologies from mechanical, electronic, computer, and control engineering. They create blueprints or design documents for parts, assemblies or finished products using software programs, and also oversee and manage projects.
Optical engineer: Optical engineers design and develop different industrial applications with optics. They have knowledge of light, light transmission principles, and optics in order to design engineering specs of equipment such as microscopes, lenses, telescopes, and other optical devices.
Optomechanical engineer: Optomechanical engineers design and develop optomechanical systems, devices, and components, such as optical mirrors and optical mounts. Optomechanical engineering combines optical engineering with mechanical engineering in the design of these systems and devices. They conduct research, perform analysis, test the devices, and supervise the research.
Automation engineer: Automation engineers research, design, and develop applications and systems for the automation of the production process. They implement technology and reduce, whenever applicable, human input to reach the full potential of industrial robotics. Automation engineers oversee the process and ensure all systems run safely and smoothly.
ICT system integration consultant: ICT system integration consultants advise on bringing together different systems to interoperate within an organisation for enabling data sharing and reducing redundancy.

Operations manager: Operations managers plan, oversee and coordinate the daily operations of production of goods and provision of services. They also formulate and implement company policies and plan the use of human resources and materials.
Crane technician: Crane technicians assemble industrial and harbor cranes components. They install conveyors and controls. Crane technicians perform the final assembly on site and maintain and repair cranes.
Electronics drafter: Electronics drafters support electronic engineers in the design and conceptualisation of electronic equipment. They draft blueprints and assembly diagrams of electronic systems and components using technical drawing software.
Telecommunications engineering technician: Telecommunications engineering technician deploy, maintain and monitor a telecommunication system that provides interactions between data and voice communications, such as telephone, video conferencing, computer, and voicemail systems. They are also involved in the design, manufacturing, construction, maintenance and repair of telecommunication systems. Telecommunications engineering technicians provide technical assistance in the research and development of telecommunication equipment.
ICT system architect: ICT system architects design architecture, components, modules, interfaces, and data for a multi-components system to meet specified requirements.
Agricultural machinery technician: Agricultural equipment technicians repair, overhaul and maintain agricultural equipment including tractors, tillage equipment, seeding equipment and harvesting equipment. They perform evaluations of the equipment, perform preventive maintenance activities and repair faults.
Integrated circuit design engineer: Integrated circuit design engineers design the layout for integrated circuits according to electronics engineering principles. They use software to create design schematics and diagrams.
Application engineer: Application engineers deal with the technical requirements, management, and design for the development of various engineering applications, such as systems, new product designs, or the improvements of processes. They are responsible for the implementation of a design or process improvement, they offer technical support for products, answer questions about the technical functionality and assist the sales team.

References

1. Provide technical documentation – ESCO