Your primary objective will be to communicate complex technical concepts concisely and accurately to different audiences, including end-users, developers, and stakeholders.
Responsibilities
Content Creation: Produce clear, comprehensive, and accurate technical documentation, including user guides, API documentation, developer guides, system manuals, release notes, and other supporting materials.
Documentation Planning: Collaborate with cross-functional teams, including product managers, engineers, and subject matter experts, to gather information and plan documentation projects.
Content Organization: Organize and structure technical content in a logical and user-friendly manner, ensuring ease of navigation and retrieval.
Review and Editing: Review and edit technical documents for grammar, clarity, consistency, and adherence to the company's style and branding guidelines.
Visual Communication: Able to create technical illustrators to incorporate visual elements, such as diagrams, screenshots, and illustrations, into the documentation to enhance understanding.
Information Gathering: Research and acquire a deep understanding of complex technical concepts, products, and features to accurately document them.
Documentation Maintenance: Update and maintain existing technical documentation to reflect changes and updates in products and services.
Collaboration: Collaborate with cross-functional teams, developers, and product managers to obtain information and ensure documentation accuracy.
User Assistance: Develop context-sensitive help, online FAQs, and knowledge base articles to support users in troubleshooting and self-service.
Documentation Tools: Utilize various documentation tools, such as version control systems, content management systems, and authoring tools, to create and manage documentation efficiently.
Required Skills
Proven experience as a Technical Writer, preferably in a senior or lead role (8+ years)
Bachelor's degree in Technical Communication, English, Computer Science, or 8 years of Technical Writer experience.
Strong technical writing skills with the ability to explain complex technical concepts in a clear and concise manner.
Proficiency in using documentation tools like Microsoft Word, Adobe FrameMaker, or other relevant authoring tools.
Experience with documentation regarding network, account management areas.
Familiarity with version control systems (e.g., Git) and content management systems.
Solid understanding of software development processes, with hands-on coding experience being a plus.
Excellent communication, organizational, and time management skills.
Detail-oriented with a strong commitment to quality and accuracy.
Ability to work independently and collaboratively in a team environment.
Experience with API documentation and familiarity with RESTful API concepts.
Seniority level
Mid-Senior level
Employment type
Full-time
Job function
Marketing, Public Relations, and Writing/Editing
Industries
Staffing and Recruiting
Referrals increase your chances of interviewing at EXOS TALENT by 2x