Technical Writer (Remote)

A US-based company runs software that serves as the backbone for manufacturing companies across various sectors, including Industrial and Capital Equipment, Automotive, Aerospace and Defense, and Medical Devices. It helps its clients reach the market 5x faster by automating the hand-off from engineering to manufacturing. They have pioneered a solution that translates CAD data directly into ERP systems, enabling engineers to focus on what they do best: designing and building.

The company is committed to client satisfaction and has grown into an industry leader. The driving force behind this commitment is an unwavering belief in clear and effective communication.

Currently, the team is searching for an experienced Technical Writer to join their team and help take their client-focused services to new heights. The ideal candidate will have proven success in a highly technical field such as software development, computer science, or engineering. They should be able to evaluate and analyze complex information and possess a natural desire to help people understand it.

Key Responsibilities:

• Documentation Creation: Prepare instruction manuals, user manuals, API documentation, installation guides, troubleshooting guides, and software release notes.
• Collaboration: Work with software engineers, product managers, and other stakeholders to understand software features, workflows, and functionality, translating these into user-friendly content.
• Content Structuring: Organize and structure content logically to ensure its easy to follow for users with various technical expertise, from beginners to advanced.
• Editing and Proofreading: Ensure technical accuracy and clarity while reviewing and editing content for grammar, consistency, and formatting.
• Diagrams and Visual Aids: Develop flowcharts, diagrams, screenshots, and tutorials to aid in explaining complex technical concepts.
• Content Management: Develop and maintain a detailed database of reference materials, including research, usability tests, design specifications, and centralized storage for data.
• API Documentation: Write high-quality API documentation that allows developers to understand and integrate with our APIs.
• Feedback Integration: Gather and implement feedback from internal teams and users to improve documentation quality.
• Standards Compliance: Ensure all documentation adheres to company style guides and industry standards.

Objectives of this Role:

• Develop comprehensive documentation that meets organizational standards and user needs.
• Gain an in-depth understanding of products and services and translate complex information into simple, polished, and engaging content.
• Create technical documentation for marketing and our product within the organization.
• Evaluate current content and develop innovative methods for improvement.

Qualifications:

• Education: Bachelor’s degree in Technical Writing, Journalism, Information Systems, or a related field.

Experience:

• Proven experience (2+ years) as a technical writer, particularly in software development or related fields.
• Experience creating documentation for diverse audiences, including end-users, developers, and internal teams.
• Experience writing user interface text, online help, and developer guides.

Skills:

• Ability to quickly grasp complex technical concepts and explain them clearly and simply.
• Superb written communication skills with attention to detail.
• Proficiency with documentation and publishing tools such as Zendesk Guide, Camtasia, SnagIt, Confluence, and MS Office.
• Familiarity with software development life cycle (SDLC) and basic programming concepts.
• Ability to manage multiple projects and meet tight deadlines.
• Basic understanding of XML, Markdown, and version control systems like Git.

Preferred Skills and Qualifications:

• Firm understanding of the SDLC (software development lifecycle).
• Previous experience in software development or engineering.
• Experience with creating content in alternative media formats.
• Familiarity with content management systems (CMS) and tools for API documentation.
• Experience improving user experience (e.g., refining UI designs).

This role is perfect for individuals passionate about simplifying technical processes and empowering users with clear and effective documentation. If you’re excited to work with a dynamic and innovative team, we’d love to hear from you!