Career Center
Rolla, Missouri
Cary, North Carolina
Charleston, South Carolina
Washington, D.C.
Davis, California
New York, NY
Linthicum, Maryland
Berkeley, California
Posted: 28-Sep-23
Location: Mumbai, India
Type: Full Time
Categories:
Required Education:
Additional Information:
Internal Number: 192
This is a remote job for applicants in South America or India!
We are seeking an experienced Senior Technical Documentation Writer to be responsible for creating comprehensive, clear, and well-structured documentation, including API, SDK (JavaScript and other libraries), and infrastructure documentation. Excellent communication skills, expertise in writing API documentation, and familiarity with the Open API specification are essential for this role. 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.
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;
- 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.
Benefits
Our goal is to make your routine as a Rocketeer feel enjoyable, exciting, and comfortable in a 100% remote environment. So, you’ll receive a set of benefits to improve your remote work experience! They include a flexible schedule, unlimited Paid Time Off, language and tech courses, stock options, a multicultural environment with colleagues in over 26 countries, a vibrant company culture, and more!
Mandatory Hard Skills (you will go through a technical test stage to validate your technical skills)
- A minimum of 4-5 years of software technical writing experience; Ability to write comprehensive, clear, and well-structured documentation that is easily understandable by various audiences;
- Ability to read code, and write code snippets;
- 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;
- Experience working in Agile development environments;
- Experience documenting APIs (REST, SOAP) and other programming languages, demonstrating the ability to understand and write sample code;
- Ability to conduct reviews and revamps of section or page content and structure, improving overall readability and enhancing the user experience;
- Skill in collaborating with the user community by reviewing and triaging suggestions, corrections, and other content, valuing their input and actively incorporating their contributions;
- Capability to enhance developer documentation by providing relevant sample code, reducing the integration efforts for external developers;
- 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;
- Capability to provide technical guidance and support to team members, promoting a culture of continuous learning and knowledge sharing;
- Stay informed about industry best practices in technical writing, keeping abreast of the latest trends and sharing insights to improve documentation practices.
Desirable Hard Skills
- Experience with open-source is a plus;
- Experience with GitBook is a plus;
- Experience in the fintech industry.
Soft Skills
- Good Communication skills;
- Self-organized;
- Autonomous when required;
- Adept at building relationships within other cross-functional teams;
- Experience in receiving feedback;
- Comfortable with remote work, especially in collaboration with others across countries and time zones;
- Attention to detail;
- Strong focus on accuracy, clarity, and adherence to established guidelines when reviewing and editing documentation for new and enhanced features;
- A proactive approach to contributing to the continual improvement of documentation through feedback analysis, support tickets, interviews, and a focus on usability and effectiveness;
- 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;
- Effective collaboration with cross-functional teams and stakeholders, aligning documentation strategies with business goals and user needs.
