Determine the needs of users of technical documentation
Work with product team and development team to make products easier to use and thus require fewer instructions in the documentation. Hence, needs to be involved and contribute to all aspects of an agile software development lifecycle.
Obtain a deep understanding of products and services to translate complex product information into simple, polished, and engaging content for people with different backgrounds and to minimize mis-usage of the products.
Select appropriate medium/platform for message/content or audience, such as manuals, online videos, photographs, drawings, diagrams, animation, and charts that increase users’ understanding of the material; then standardize content across platforms/media
Design, write, organize contents for maximum usability, with a consistent and cohesive voice across all documentations.
Independently research, outline, write, and edit new and existing content, working closely with various internal/external stakeholders and subject matter experts to understand project and product requirements.
Communicate content and changes of technical document to its users, including but not limited to maintain changelog, make announcement, create articles of higlights or educational content, etc
Updates job knowledge by studying state of the art documentation tools, writing techniques and language proficiency; participating in educational opportunities; reading professional publications; maintaining personal networks; participating in professional organizations
Protect operations by keeping information confidential
Engage and collaborate with end users to address content gaps, gain as well as to respond to feedback and promote continuous improvement of documentation experience. Make revision of content as new issues arise and proactively seek a solution to problems.
Coordinate final technical documentation to ensure that all requirements and deadlines are met.
2-3 years experiences in same position
Bachelor degree, further education in Computer Science or Software Engineering, or equivalently.