About Company
Crowdicity is a leading SaaS platform revolutionizing how organizations engage with their communities to drive innovation and solve complex challenges. Based in Exeter, UK, with a global reach, we empower businesses, governments, and non-profits to harness the collective intelligence of their employees, customers, and citizens. Our platform facilitates idea generation, collaboration, and decision-making, transforming concepts into tangible solutions. We pride ourselves on a culture of innovation, collaboration, and continuous learning, fostering an environment where talented individuals can make a real impact on our product and our users’ success. We believe in building intuitive and powerful tools, and clear, comprehensive API documentation is critical to our mission.
Job Description
Crowdicity is seeking a highly skilled and motivated Remote API Documentation Specialist to join our dynamic and growing product team. In this pivotal role, you will be instrumental in creating, maintaining, and enhancing our API documentation, ensuring it is clear, accurate, and easily accessible for both internal development teams and external partners. As a Remote API Documentation Specialist, you will work closely with our engineering, product management, and support teams to understand complex technical concepts and translate them into user-friendly documentation. Your work will directly impact our developers’ ability to integrate with our platform efficiently and our partners’ success in leveraging Crowdicity’s powerful capabilities. This is an exciting opportunity for someone passionate about technical communication, with a strong understanding of APIs and a knack for explaining intricate systems in a straightforward manner. You will play a crucial role in shaping the developer experience, contributing to the overall usability and adoption of our API services. If you thrive in a collaborative remote environment and are committed to excellence in technical writing, we encourage you to apply.
Key Responsibilities
- Design, write, and maintain comprehensive, high-quality documentation for Crowdicity's RESTful APIs, including developer guides, API reference, tutorials, and integration examples.
- Collaborate closely with engineering and product teams to gather information, understand API functionality, and ensure documentation accuracy and completeness.
- Act as a primary advocate for the developer experience, ensuring documentation is user-centric, easy to navigate, and facilitates quick integration.
- Implement and uphold best practices for API documentation, style guides, and information architecture.
- Regularly review and update existing documentation to reflect new features, changes, and improvements to the API.
- Work with internal and external developers to solicit feedback on documentation and continuously improve its clarity and usability.
- Manage documentation within version control systems (e.g., Git) and utilize documentation generation tools (e.g., OpenAPI/Swagger, Markdown).
- Contribute to the strategic planning and design discussions related to API development, advocating for documentation considerations early in the lifecycle.
- Create and maintain code samples, SDK documentation, and example use cases to demonstrate API functionality.
Required Skills
- Proven experience (4+ years) as an API Documentation Specialist, Technical Writer, or similar role focusing on developer-facing documentation.
- Expertise in documenting RESTful APIs, including a strong understanding of HTTP methods, request/response cycles, and authentication.
- Proficiency with API specification formats such as OpenAPI/Swagger.
- Exceptional written and verbal communication skills, with an ability to explain complex technical concepts clearly and concisely.
- Experience using documentation tools and platforms (e.g., Markdown, Git, Confluence, ReadMe.io, Postman).
- Familiarity with software development lifecycles and Agile methodologies.
- Ability to read and understand code samples in common languages (e.g., JSON, XML, JavaScript, Python) to create accurate documentation and examples.
- Strong organizational skills and attention to detail, with the ability to manage multiple documentation projects simultaneously.
Preferred Qualifications
- Bachelor's degree in Technical Communication, Computer Science, English, or a related field.
- Experience working in a SaaS or cloud-based environment.
- Familiarity with developer portals and SDK documentation.
- Understanding of user experience (UX) principles for technical documentation.
- Prior experience with content management systems (CMS) for documentation.
- Basic knowledge of front-end web technologies (HTML, CSS, JavaScript) to understand integration points.
Perks & Benefits
- Fully remote work flexibility, allowing you to work from anywhere in the UK.
- Competitive salary and pension scheme.
- Generous holiday allowance.
- Opportunities for professional development and continuous learning.
- Access to a comprehensive well-being program.
- A vibrant, inclusive, and supportive company culture.
- Regular virtual team events and social gatherings.
- The chance to make a significant impact on a product used by global organizations.
How to Apply
Interested candidates are encouraged to click the ‘Apply Now’ link below to submit their resume and a compelling cover letter. In your cover letter, please detail your relevant experience in API documentation, highlight any specific tools or platforms you’re proficient with, and explain why you believe you’d be a great fit for Crowdicity and this remote role. We look forward to reviewing your application!