Technical Documentation Writer

Job Title: Technical Documentation Writer

Level: Mid Level

Working Hours: Full Time (40h/Week)

Location: Remote (EMEA)

Your Team 👥

You will report to our product documentation team lead and join the Product Documentation team. On TheOrg you can view the complete structure of our organisation, including information about every team member, hiring managers and the size of each department.

Your Responsabilities ✏️ 

Develop and Maintain Technical Documentation:

Create, update, and manage high-quality documentation for Rocket.Chat, including user guides, API documentation, integration manuals, and video tutorials. Ensure that all documents are clear, concise, and user-friendly.

API Documentation:

Utilize your expertise in Swagger and OpenAPI specifications to develop accurate and comprehensive API documentation, ensuring developers can easily integrate with Rocket.Chat's platforms.

Collaborate Cross-Functionally:

Work closely with developers, product managers, UX/UI designers, and other cross-functional teams to gather technical information and ensure alignment in documentation.

Adapt and Simplify Complex Information:

Translate complex technical concepts into simple, accessible, and actionable content for a diverse audience, including technical and non-technical users.

Leverage Documentation Tools:

Use markup languages (Markdown, HTML, XML) and documentation tools (e.g., Confluence, ReadTheDocs) to organize and publish content effectively.

Support Multimedia Content Creation:

Assist in creating video tutorials, infographics, and other multimedia content to complement written documentation and enhance user understanding.

Maintain Consistency and Accuracy:

Ensure all documentation adheres to established standards for tone, structure, and accuracy, performing rigorous reviews to eliminate errors.

Remote Collaboration and Knowledge Sharing:

Work effectively in a remote, globally distributed team environment, fostering a culture of transparency, knowledge sharing, and continuous learning.

Stay Current with Industry Trends:

Keep up-to-date with emerging tools, technologies, and best practices in technical writing and software documentation.

Own Your Work:

Take ownership of documentation projects from inception to completion, setting high standards and being accountable for delivering quality outcomes on time.

Champion Rocket.Chat's Mission:

Align documentation efforts with Rocket.Chat’s mission, ensuring that all content contributes to a seamless and engaging user experience.

Mandatory Hard Skills 🎯

• Native/Fluent English;
• Technical Writing Proficiency: Expertise in creating clear, concise, and comprehensive documentation, including user guides, API documentation, and online help content.
• Understanding of Software Development: Familiarity with software development processes and methodologies, such as Agile or Scrum, to effectively collaborate with development teams.
• Markup Languages: Proficiency in markup languages such as Markdown, HTML, and XML, which are commonly used for writing and formatting documentation.
• API Documentation Tools: Knowledge of tools and specifications for documenting APIs, such as Swagger (OpenAPI) or RAML, to create accurate and user-friendly API documentation.
• Technical Proficiency: Ability to read and understand code snippets and examples in programming languages relevant to the project (e.g., JavaScript), to write accurate documentation and examples.
• Basic knowledge of servers, CLI, networking, and cloud technologies like Docker and Kubernetes.

Desirable Hard Skills 💕 

• Documentation Management Tools: Experience with documentation tools and content management systems (CMS) like Confluence, Document360, gitbook, or similar, to organize and publish documentation.
• Video and Graphic Editing: Skills in video production and graphic editing tools (e.g., Camtesia) for creating multimedia content that complements written documentation.
• Technical Communication Degrees or Certifications: Advanced degrees or certifications in technical communication, professional writing, or a related field that provides a theoretical and practical foundation in technical writing.

Soft Skills ✨

• Effective Communication: Ability to clearly and concisely convey information in written and verbal form, tailoring the message for different audiences, including technical and non-technical stakeholders.
• Active Listening: Being fully present and engaged in conversations, showing a genuine effort to understand others' viewpoints, and incorporating feedback into documentation.
• Team Collaboration: Working cooperatively with cross-functional teams, including developers, product managers, and support staff, to achieve common goals and produce cohesive and comprehensive documentation.
• Adaptability: Flexibility in handling changes in technology, project requirements, and team dynamics, with a willingness to learn and apply new tools and processes.
• Problem-Solving: Ability to identify issues in documentation or project workflows and creatively find effective solutions, improving efficiency and quality.
• Time Management: Managing workload effectively, prioritizing tasks to meet deadlines while maintaining high-quality standards in a fast-paced environment.
• Attention to Detail: A keen eye for detail to ensure accuracy, clarity, and consistency in documentation, catching and correcting errors before publication.
• Passion: Genuine enthusiasm for what you do and how it contributes to our company's mission;
• Dream: Proactively seek out opportunities and challenges to achieve extraordinary results. If you're someone who takes initiative and is always striving to improve, you'll fit right in;
• Own: Take ownership of your work, set high standards for yourself, and be accountable for outcomes demonstrating a strong sense of responsibility and commitment; 
• Trust: Recognizing the importance of trust and support and actively working towards a collaborative and inclusive workplace;
• Share: Communicating openly and transparently ensures clarity and honesty in interactions. 

What You'll Do 🖥️

• Utilize your experience in software technical documentation writing to create high-quality documentation for Rocket.Chat.
• Apply your knowledge of Swagger and Open API specification to document Rocket.Chat's APIs accurately.
• Use your excellent communication skills to explain complex concepts simply and clearly to a diverse audience.
• Produce various technical writing deliverables, including user guides, API documentation, and UX micro-content, supporting the effective use of Rocket.Chat.
• Collaborate remotely with cross-functional teams, building strong relationships and fostering teamwork.
• Quickly learn and understand complex technical concepts to ensure accurate documentation.
• Embrace feedback to improve the quality and usability of Rocket.Chat's documentation.
• Work comfortably in a remote setting, collaborating across different countries and time zones.
• Collaborate with team members, fostering a culture of knowledge sharing.