Keith Johnson was the key speaker in the fourth session of the Technical Writing Project Lifecycle workshop organized by Advanced Technical Writing Group in association with Metapercept Technology Solutions and Oxygen XML. He has over 25 years of experience in technical communications.
The technical writing role is not restricted to the documentation of the product or service. It, undoubtedly, is the primary responsibility of a technical writer. But, to become a successful and productive technical writer, you are expected to be more than a set of skills mentioned in the job description. In this session of Technical Writing Project Lifecycle, Amit Siddhartha, CEO of Metapercept Technology Services, enlightens the technical writers about the initiatives a technical writer needs to take for delivering responsibilities effectively.
Mridula Menon, in the first session of this…
In the first session of the fourth workshop organized by Advanced Technical Writing Group, in association with Metapercept and Oxygen XML, Mridula Menon shared her experience as a technical writer. Her insights throw light on different aspects of a technical writing career. The key idea behind the workshop was to ensure that the attendees become effective technical writers by leaving minimum room for hiccups during the documentation process.
Want to be a technical writer? We have a proper guide on how you can start a career in technical writing. Technical writing is not as easy as it seems. It is not just about understanding technical information and writing it down on a document, but it takes high-level information and processes it into content that is suitable for a specific audience.
An another perspective of viewing the entire documentation process is to understand the process of the Software Development Life Cycle (SDLCC). If you have studied software engineering or how the software development process takes place, you can relate to that.
The product has become a necessity for most of the business including retail, education and legal. Also, there are many products in the market as our competition. We need to stay ahead of our competition for the same reason we need to hit the market as soon as possible. There are many queries in every person who wants to build a product. The most important query is how to save cost and what are the ways to improve time?
How much importance do you give to the hashtag#informationgathering process as a technical writer? As per my experience, to create a technical document, a technical writer must understand the subject, purpose, and audience. They gather information by studying existing material, interviewing SMEs, and often actually using the product. They study the audience to learn their needs and technical understanding level. In short, they process highly technical information into digestible form for the non-technical and technical audience.
The recent technological trends indicate that the need…
It is easy to assume that content is the only element users care about whenever they use documentation. But such an assumption is absolutely far from reality. Design is one of the most crucial elements of any online documentation. Visually-appealing documentation such as a user guide that contains relevant images and has appropriate videos embedded in it alongside with fonts and theme that aligns with the website design is always visually appealing to users and more user-friendly!