Position Summary:
We are seeking a detail-oriented and technically proficient Document Specialist to join our team. The ideal candidate will be responsible for creating, editing, and maintaining technical documentation that is clear, concise, and accurate. The Document Specialist will collaborate closely with subject matter experts to gather information and ensure documentation reflects the latest product features and updates. Additionally, the role involves organizing information in a logical manner, adhering to style guides, and testing documentation for usability and completeness.
Job Details:
- Work from Home
- Monday to Friday | 3 PM to 12 AM PST
- *Following PH Regular Holidays
Responsibilities:
- Research and Gather Information: Conduct thorough research by interviewing subject matter experts, reading technical specifications, and testing products or software to gather information for documentation.
- Write and Edit Documentation: Create clear, concise, and accurate technical documentation, including how-to guides, API documentation, and release notes. Edit and revise documentation as needed for clarity, accuracy, and completeness.
- Organize Information: Structure documentation in a logical and easy-to-follow manner, considering the needs and knowledge level of the target audience. Utilize appropriate headings, tables of contents, and navigation aids to facilitate quick information retrieval.
- Collaborate with Subject Matter Experts: Work closely with engineers, product managers, and other subject matter experts to ensure the accuracy and completeness of documentation.
- Maintain Documentation: Keep documentation up-to-date with changes to the product, software, or processes. Track changes in source code, attend meetings to learn about upcoming changes and update documentation accordingly.
- Ensure Consistency and Style: Follow established style guides and documentation standards to maintain a professional and cohesive voice. Ensure consistency in terminology, formatting, and writing style across all documentation.
- Test Documentation: Review documentation from a user's perspective to ensure clarity, understandability, and helpfulness. Test instructions and procedures to verify accuracy and completeness, and incorporate user feedback to improve documentation.
- Manage Documentation Projects: Plan and prioritize documentation tasks, set deadlines, and coordinate with other team members to ensure documentation projects are completed on time.
- Stay Updated on Industry Trends: Keep abreast of industry trends, best practices, and new technologies related to technical writing and documentation. Continuously improve skills and knowledge through training, workshops, and professional development opportunities.
Qualifications:
- 1–2 years of experience in technical writing or documentation.
- Strong English verbal and written communication skills.
- Excellent writing skills with a strong command of English grammar, punctuation, and syntax.
- Understanding of technical concepts and the ability to translate complex information for a non-technical audience.
- Strong attention to detail to ensure accuracy and completeness in technical documentation.
- Proficiency with documentation tools such as Google Docs, Screensteps, Guidde, or similar software.
- Basic knowledge of markup languages such as XML, HTML, and CSS.
- Experience with documenting APIs and familiarity with RESTful APIs and tools like Swagger or OpenAPI.
- Understanding of UX writing principles to create user-friendly documentation.
- Ability to collaborate effectively with cross-functional teams.
- Strong problem-solving skills and basic project management skills.
- Adaptability to learn new tools, technologies, and processes in a fast-paced environment.
- Understanding of QA principles and processes to ensure documentation accuracy and quality.