Technical Author

ParentPay Group - India; Pune District; On-site; INR 1,200,000 - 1,500,000; Full time

Job summary

A leading software product company in Pune is looking for a Technical Author to create comprehensive API documentation, develop guides, and collaborate with engineering teams. The candidate should have over 6 years of technical writing experience and a strong understanding of API technologies such as REST and SOAP. This role is full-time and emphasizes the ability to simplify complex ideas and communicate effectively.

Qualifications

• 6+ years of experience as a technical writer of software documentation.
• Strong understanding of API technologies like REST, SOAP, and GraphQL.
• Ability to simplify complex concepts for technical documentation.

Responsibilities

• Create and maintain comprehensive API documentation.
• Develop guides, tutorials, and reference materials for API usage.
• Collaborate with software developers and product managers.

Skills

Technical writing

API technologies

Communication skills

Version control systems

Programming languages

Tools

Postman

Swagger

Markdown

Doxygen

Confluence

Job description

Technical Author – ParentPay Group - India

Company Overview: 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 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 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.

Department: Software Development

Location: Pune, India

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, and 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, and create tutorials 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.

Seniority Level

Mid‑Senior level

Employment Type

Full‑time

Job Function

Marketing, Public Relations, and Writing/Editing

Industries

IT Services and IT Consulting