The Department of Computer Engineering (DEI) of the Engineering Institute of Porto (ISEP), in collaboration with the Master in Computer Engineering (MEI), invites to participate in another lecture, this time with the theme "Technical Writing for Engineers", which will take place on April 15th, at 6pm, at ISEP.
The event will take place in room B103 at ISEP.
Abstract
As businesses grow, so does the need for technical documentation. Up-to-date technical documentation can save precious time for developers, and, consequently, save money for our company. The production of up-to-date technical documentation should include not only technical writers but also developers (engineers). Technical writers know how to write, but developers are the subject matter experts.
Instead of doing all the writing, technical writers should work side-by-side with teams, providing them the means to produce their documentation. In this talk, I will start by showing how good technical documentation can impact the daily lives of developers and product managers. Then, I’ll introduce the basic concepts of technical writing. Finally, I will explain how technical writers and developers can work side by side and propose a small exercise.
Short Bio
I started working as a Technical Writer at Altitude. Then, I did my PhD in Natural Language Processing. The theme of my thesis was book recommendation based on the processing of book content. After finishing my PhD I returned to Altitude to work as a Technical Writer and then moved to Farfetch. At Altitude and Farfetch, I documented applications with graphical interfaces and APIs. I really enjoyed working with APIs, learning from developers and writing to developers (D2D). I’m also a facilitator of Google Technical Writer courses for engineers. During this time I also managed internal documentation sites and developed some scripts to automate the generation of the documentation. Recently, I left Farfetch and started working at Coremedia.
Full information on DEI website here
Organization
This lecture is organized by QTDEI in collaboration with the Master in Informatics Engineering (MEI) of the Engineering Institute of Porto (ISEP).