We invite you to join the Greycroft Talent Network

197
companies
954
Jobs
Leverage our network to build your career.
Tell us about your professional DNA to get discovered by any company in our network with opportunities relevant to your career goals.

Senior Technical Documentation Writer (Software Documentation)

Rocket.Chat

Rocket.Chat

Marketing & Communications, IT
São Paulo, SP, Brazil
Posted on Monday, June 26, 2023

This is a remote job for applicants worldwide!

Dreaming, owning, trusting and sharing is the basis of who we are as Rocketeers and we're looking for someone who sees themselves in this too! So if you take initiative and responsibility, while being accountable and freely giving and asking for feedback, always working with transparency in your actions and tasks, this role is for you!

Our platform is a highly distributed system leveraging modern database and messaging technologies. As a technical documentation writer, you will use your writing and technical skills to write clear and consistent documentation and tutorials on high-complexity features. You will write for experienced developers, non-technical users, and business decision-makers. Your work will support a large global community of Rocket.Chat users.

We are seeking an experienced Senior Technical Documentation Writer with a minimum of 4-5 years of software technical writing experience, preferably in the fintech industry. As a Senior Technical Writer, you will be responsible for creating comprehensive, clear, and well-structured documentation, including API, SDK (JavaScript and other libraries), and infrastructure documentation. Excellent communication skills, ability to read code, write code snippets, expertise in writing API documentation, and familiarity with the Open API specification are essential for this role.

The technical documentation writer will be a member of the Product team and will work closely with our teams to understand all aspects of our product suite, with a focus on developer documentation.

Your skills 🎯

  • Excellent writing skills: Ability to write comprehensive, clear, and well-structured documentation that is easily understandable by various audiences.
  • Technical writing expertise: Proven track record of writing API, SDK, and infrastructure documentation, showcasing a deep understanding of technical concepts and the ability to translate them into user-friendly content.
  • Agile development knowledge: Experience working in Agile development environments and documenting APIs (REST, SOAP) and other programming languages, demonstrating the ability to understand and write sample code.
  • Attention to detail: Strong focus on accuracy, clarity, and adherence to established guidelines when reviewing and editing documentation for new and enhanced features.
  • Content optimization: Ability to conduct reviews and revamps of section or page content and structure, improving overall readability and enhancing the user experience.
  • Community engagement: Skill in collaborating with the user community by reviewing and triaging suggestions, corrections, and other content, valuing their input and actively incorporating their contributions.
  • Sample code creation: Capability to enhance developer documentation by providing relevant sample code, reducing the integration efforts for external developers.
  • Continuous improvement mindset: Proactive approach to contribute to the continual improvement of documentation through feedback analysis, support tickets, interviews, and a focus on usability and effectiveness.
  • Technical acumen: Strong understanding of Rocket.Chat and its integrations, with a commitment to staying up-to-date on new features and integrations and actively sharing insights with the team.
  • Leadership qualities: Ability to mentor and guide junior technical writers, sharing expertise, fostering professional growth, and creating a culture of knowledge sharing.
  • Project ownership: Take ownership of documentation projects, driving them to successful completion within given timelines and ensuring high-quality deliverables.
  • Collaboration and alignment: Effective collaboration with cross-functional teams and stakeholders, aligning documentation strategies with business goals and user needs.
  • Technical guidance: Capability to provide technical guidance and support to team members, promoting a culture of continuous learning and knowledge sharing.
  • Subject matter expertise: Stay informed about industry best practices in technical writing, keeping abreast of the latest trends and sharing insights to improve documentation practices.

What you'll do 🧑‍💻

  • Utilize your software technical documentation writing experience to create high-quality documentation for Rocket.Chat.
  • Demonstrate your proven track record of writing clear and concise API documentation, ensuring that developers can easily understand and implement the provided instructions.
  • Apply your expertise in swagger and Open API specification to accurately document Rocket.Chat's APIs, adhering to industry standards and best practices.
  • Utilize your excellent written and verbal communication skills, along with your attention to detail, to convey complex concepts in a simple and understandable manner for diverse audiences.
  • Create various technical writing deliverables, such as user guides, help articles, high-level overviews, API documentation, knowledge base documentation, and UX micro-content, to support users in effectively utilizing Rocket.Chat.
  • Leverage your self-organization and autonomy to collaborate with cross-functional teams remotely, building strong relationships and fostering effective teamwork.
  • Showcase your quick learning ability by efficiently and effectively grasping complex technical concepts, ensuring accurate and comprehensive documentation.
  • Apply your experience in receiving feedback and implementing changes to continuously improve the quality and usability of Rocket.Chat's documentation.
  • Demonstrate your comfort with remote work and your ability to collaborate with team members across different countries and time zones to ensure smooth and efficient documentation processes.
  • Exhibit your strong leadership qualities by mentoring junior team members, taking ownership of documentation projects, fostering collaboration, and sharing knowledge with the wider team.
  • Embrace opportunities for knowledge sharing, staying updated on industry trends and best practices, and actively contributing to the improvement of documentation processes and standards at Rocket.Chat.

Note: Please provide examples of your technical writing on public URLs with your application.

Join our team and contribute to the continual improvement of Rocket.Chat's documentation. Apply now to be part of an innovative company driving change in the industry!

Benefits

Wherever you are our goal is to make your routine as a Rocketeer feel enjoyable, exciting, and comfortable, so if you are remote or working from our office in Porto Alegre (Brazil) you’ll receive a set of benefits to improve your work experience! They include a flexible schedule, multicultural environment with colleagues in over 30 countries, a vibrant company culture, remote work as you wish, unlimited Paid Time Off, language and tech courses and more!

About Rocket.Chat 🚀

‍Rocket.Chat is the world's largest open source communications platform. Built for organizations that need more control over their communications, it enables collaboration between colleagues, partners, customers, communities, and even platforms without compromises on data ownership, customizations, or integrations.

Tens of millions of users in over 150 countries and organizations such as Deutsche Bahn, the U.S. Navy and Credit Suisse trust Rocket.Chat every day to keep their communications completely private and secure.

As Rocket.Chat we believe in reconnecting the world, one conversation at a time! See yourself in that? So apply now!