Department: Software Development
Location: Pune, India
Description
ParentPay Group is Europe's leading software product company and the UK's largest education technology business. We are on a mission to bring next-generation innovation to positively impact on the lives of millions of parents, teachers, and students every day in over 49 countries.
Our market leading products use cutting edge cloud-based technology to streamline school processes, including secure web and mobile apps that enable secure online payments for school items such as meals, trips, clubs and uniform, improve parental engagement, simplify meal management and - through our product SIMS - collect and manage a database of student information and core school operations.
ParentPay Group's new offices in Pune are a fantastic tech hub for those looking to boost their careers in software product development.
Our bright team FastTrack their career with international exposure and ways of working based on agile development best practices from globally renowned technology consultancies.
Key Responsibilities
- API Documentation: Create and maintain comprehensive API documentation, including endpoints, authentication methods, request/response formats, and error handling.
- Technical Writing: Develop guides, tutorials, and reference materials that explain API usage in an accessible manner. Provide thorough descriptions of an API's functions and how it interacts with the application. Make arguments in favor of how to use the API and its interactions.
- Collaboration: Work closely with software developers, product managers, and engineers to understand API functionalities and ensure accurate documentation.
- Content Structuring: Organize information architecture to enhance readability and usability.
- Code Samples & Use Cases: Provide practical examples, sample code, and use cases to help developers implement APIs effectively.
- Version Control & Updates: Regularly update documentation to reflect API changes, enhancements, and deprecations.
- Industry Standards Compliance: Ensure documentation aligns with best practices and company guidelines.
- Visual Aids: Create diagrams, flowcharts, and other visuals to simplify complex API interactions. Create tutorials about how to use the API through documents, eLearning, and video tutorials.
- User Feedback Integration: Gather feedback from developers and improve documentation accordingly.
Skills, Knowledge and Expertise
- A minimum of 6+ years of experience as a technical writer of software documentation
- Strong understanding of API technologies (REST, SOAP, GraphQL, JSON, XML).
- Proficiency in technical writing and ability to simplify complex concepts.
- Familiarity with developer tools like Postman, Swagger, and API testing frameworks.
- Experience with programming languages (Python, JavaScript, Java) for writing code samples.
- Excellent communication skills to collaborate with technical teams.
- Ability to work with version control systems (Git, GitHub).
- Knowledge of documentation tools like Markdown, Doxygen, Lucid or Confluence.
