Technical Documentation Specialist

Role Overview

Were seeking a skilled and detail-oriented Documentation Specialist to produce and manage high-quality technical and user documentation for our advanced AI-driven IIoT and enterprise SaaS platforms.

This role is critical to ensuring:

• Engineers can seamlessly integrate, maintain, and expand our complex systems.
• Customers and industrial users can operate and derive value from our products with confidence.
• Internal teams have clear references for system architectures, workflows, and operational standards.

You will collaborate with software engineers, DevOps, data scientists, product managers, and UX designers to create clear, precise, and user-centred documentation for diverse audiences. If youre passionate about explaining sophisticated technology in an accessible way and contributing to world-class products, we’d love to talk to you.

Key Responsibilities

1.

• Write and maintain:
• API documentation for RESTful and GraphQL endpoints, including:
• Authentication flows (OAuth2, JWT).
• Request/response payload examples.
• Error codes and troubleshooting guides.
• Integration guides for:
• Edge device connectivity (MQTT, OPC-UA, Modbus).
• Data pipelines for feeding AI/ML models.
• Architecture overviews for:
• Microservices deployments.
• Data storage designs (SQL, NoSQL, time-series databases).
• Document:
• System-level workflows and communication flows.
• CI/CD pipeline processes for engineering teams.
• Technical considerations for SaaS multi-tenancy and cloud deployments.
• Collaborate with developers to:
• Extract accurate technical details.
• Create easy-to-understand examples and use cases.

2.

• Produce user manuals and help guides for:
• Data-rich dashboards and visualization tools.
• Industrial analytics interfaces.
• Mobile apps used in field operations or industrial environments.
• Create:
• Step-by-step instructions with screenshots or illustrations.
• Troubleshooting sections for common user issues.
• Release notes summarizing new features and improvements.
• Work closely with UX/UI designers to:
• Align documentation tone and language with product interfaces.
• Maintain consistent terminology across all user-facing materials.
• Contribute to AI/ML-related user content:
• Explain model outputs, predictions, and limitations in user-friendly terms.
• Create disclaimers and usage notes for AI-driven features.

3.

• Maintain internal knowledge bases:
• System architecture diagrams.
• Standard Operating Procedures (SOPs).
• Incident response documentation for security and DevOps teams.
• Organize and maintain document repositories:
• Version control for documentation (e.g. Git).
• Indexing and tagging for easy search and retrieval.
• Champion documentation standards and enforce:
• Consistency in terminology.
• High-quality writing practices across teams.

4.

• Design clear, professional visuals to support documentation:
• System architecture diagrams.
• Workflow charts and sequence diagrams.
• Data flow illustrations for complex industrial processes.
• Use tools such as:
• Lucidchart, Microsoft Visio, Draw.io, or Figma for collaborative visual assets.

5.

• Evaluate existing documentation for:
• Clarity, accuracy, and completeness.
• Alignment with evolving product updates.
• Readability for diverse audiences (technical and non-technical users).
• Propose improvements for:
• Content structure and information architecture.
• Document templates and formatting standards.
• Implement:
• Documentation analytics (e.g. user feedback, page views).
• Processes for content localization and translation.
• Accessibility best practices for digital content.

Key Must-Have Skills

• Strong experience in:
• Writing developer-focused documentation for APIs, SDKs, and integrations.
• Creating user manuals and help content for software products, ideally SaaS platforms.
• Excellent written and spoken English:
• Ability to explain complex technical topics clearly and concisely.
• Impeccable grammar and attention to detail.
• Hands-on experience with:
• Markdown or reStructuredText for technical writing.
• Documentation platforms (Confluence, Git-based systems like Read the Docs, Docusaurus, etc.).
• Familiarity with:
• API tools like Swagger / OpenAPI.
• Basics of JSON, YAML, and XML for documenting technical payloads.
• Comfort working with:
• Agile development teams.
• Version control systems (Git).
• Ability to quickly learn:
• Complex technical topics, including industrial protocols and AI/ML integrations.

Nice-to-Have Experience

• Experience documenting:
• Industrial IoT systems and protocols (MQTT, OPC-UA, Modbus).
• Cloud architectures on AWS, Azure, or GCP.
• Exposure to:
• DevOps tools and CI/CD processes.
• Security and compliance documentation (OAuth2, encryption protocols).
• Skills in:
• Writing documentation designed for localization and translation workflows.
• Creating videos, interactive tutorials, or e-learning modules.
• Familiarity with:
• Time-series data systems and visualization tools.
• Documentation analytics to measure content effectiveness.

Soft Skills

• Highly organized and self-driven.
• Excellent collaboration skills across technical and non-technical teams.
• Ability to manage multiple documentation projects simultaneously.
• Proactive approach to identifying and filling documentation gaps.
• Analytical mindset for spotting inconsistencies or errors in technical content.

Education

• UG: B.Tech/B.E. in Computer Science, Information Technology, Electronics/Telecommunication, English, Journalism, or related fields.
• PG: Technical writing certifications or M.Tech/M.Sc. in relevant domains preferred but not mandatory.

Why Join Us?

• Document cutting-edge AI-driven, SaaS-based IIoT solutions transforming industries worldwide.
• Collaborate with highly skilled engineers, data scientists, and product teams working on complex, meaningful challenges.
• Gain exposure to modern documentation stacks, advanced technologies, and diverse industrial applications.
• Enjoy competitive compensation, benefits, and significant opportunities for professional growth.

PumpAcademy Private Limited is an equal opportunity employer. We value diversity and are committed to creating an inclusive environment for all employees.