If a content writer is set to transform his career to technical writing, language skills become the most important asset. However, technical writing is way more demanding than content writing in terms of constant learning and skill set upgrading.
Very often it happens that an extremely innovative…
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.
We have recently started our new program called "Buddy Up with a #TechnicalWriter. This program is specifically designed for people who are already working but want to change their career from any other field to #technicalwriting.
DITA has gained widespread adoption in the technical documentation world among companies such as Cisco, IBM (of course), Nokia, and Oracle. But DITA adoption isn’t exclusive to high tech.
Maintenance of documentation is another key aspect to look after for a high DX. In case of updates, documentation should be updated too so that there is no lack of information for the users. These practices can ensure high adoption of APIs.
The question that #documentationmanagers and #Informationarchitects often end up contemplating is that if they should hire a team of writers or outsource the work. Now, it might be safe to hire a team of technical writers, but it is always better to understand both sides of the coin before making a decision.
Any tailoring of documentation or upgrade of software can be implemented in a better and effective way. Thus, this leads to the improvement of the lifecycle of software as well as its quality.
Product documentation is imperative to impart an understanding of the product to its users. Without detailed product documentation, users might not be able to use the product effectively.
Technical Documentation - An Ongoing Process Companies have started to realize the need for API documentation. Furthermore, it is an ongoing process that requires timely maintenance and version control. Every time there is a development in the API, a new document is to be saved that highlights the changes made compared to the previous version.