We are seeking a Product Technical Writer to create clear, concise, and comprehensive documentation for our software products, someone who has predominant experience in writing documents for engineering teams / technical audiences.
NOTE: ONLY THOSE who have prepared high-level technical documentation for back-end engineers are qualified for this position. This job is NOT for the preparation of front-end user documentation.
As a Product Technical Writer, you will be responsible for collaborating with our Head of Engineering to gather information about software module , testing procedures, and usage instructions in existing web applications and websites. You will then use that information to create documentation that will serve as training materials and knowledge transfer tools for developers and end-users.
For screening purpose, You need to provide a portfolio of your work, including examples of API documentation you have written
- Create and deliver high quality product technical documentation including user manuals, new feature releases, system operation guides, release notes, integration guides, API content to developers and end-users alike.
- Understand complex technical modules and create an organized description of it with easily understandable text and pictures
- Work with the leadership team and internal managers to understand the software features and usage
- Ensure that documentation is accurate, complete, and up-to-date
- Write easy-to-understand user interface text, online help, and developer guides
- Prepare documentation that clearly and concisely explains how to use software modules and APIs
- Continuously update and maintain the documentation
- Strong technical background: You should have a strong understanding of the fundamentals of software development process, programming languages, and APIs to inform your technical writing
- Writing and editing skills: You must have excellent writing and editing skills, with the ability to write clear and concise documentation that is easy to understand for developers
- Collaboration skills: You should be able to work collaboratively with software developers, product managers, and other stakeholders to gather information and ensure that the documentation meets the needs of the intended audience
- Strong communication skills: You must have strong communication skills, with the ability to effectively explain complex technical concepts to developers and other stakeholders
- Proven working experience in documenting SaaS applications and software programs from a technical perspective
- Experience in writing API Documentation
- Experience describing end-user and developer procedures as they relate to the construction and/or use of software modules or applications
- Experience with preparing technical documentation of Webapps and mobile apps
- Experience with WordPress and custom plugins is a plus
