The document discusses the role of an information developer and their responsibilities in software documentation. As an information developer, the main goal is to simplify complex concepts through various documentation formats to maximize user understanding. Key tasks include planning and writing documentation according to standards, defining terminology, proofreading content, and testing documentation across distribution channels. Successful candidates typically have a university degree in technical writing or a related field, professional experience in information development, and experience with multiple languages including SAP products.
The document discusses the role of an information developer and their responsibilities in software documentation. As an information developer, the main goal is to simplify complex concepts through various documentation formats to maximize user understanding. Key tasks include planning and writing documentation according to standards, defining terminology, proofreading content, and testing documentation across distribution channels. Successful candidates typically have a university degree in technical writing or a related field, professional experience in information development, and experience with multiple languages including SAP products.
The document discusses the role of an information developer and their responsibilities in software documentation. As an information developer, the main goal is to simplify complex concepts through various documentation formats to maximize user understanding. Key tasks include planning and writing documentation according to standards, defining terminology, proofreading content, and testing documentation across distribution channels. Successful candidates typically have a university degree in technical writing or a related field, professional experience in information development, and experience with multiple languages including SAP products.
Software Design for Non-Designers (Edition Q4/2016) Week 2
By: Jorman Cacua
Information developer
I choose this role because documentation is one of the most important
things in every Project. Nowadays when we have different kinds of formats and many tools, we must work together with all the team to satisfy the user experience.
Goals and Motivations
I think main goal is simplify complex concepts or processes through different formats to maximize user comprehension. The final goal of a particular document, or independing of the methods that we use, is to help user to find what they need, understand what they find and use what they understand appropriately.
Tasks and Activities
One of the principal activities of the information developer are: -
Plans and writes documentation in line with specific Standards
and Guidelines. Works in close cooperation with other project members (e.g. from development, product management) to describe the application, installation, and configuration of the software. Defines and maintains terminology and glossary in own domain for documentation and UI texts. Proofreads and edits content for linguistic correctness, readability, usability and correct terminology. Triggers language editing process (if applicable). Runs appropriate quality checks, actively gathers feedback on documentation from at least internal stakeholders, and adequately reacts on customer feedback (e.g. from CSN tickets or Help Portal feedback). Tests the output of the documentation on every distribution channel.
Education & Skills
-
University degree (for example, in technical writing or a related
subject, such as languages, translation or communication studies). Professional experience in information development. Speak and write another language. Experience in SAP products.