06 Aug
|
Derive Management Solutions
|
India
06 Aug
Derive Management Solutions
India
Key Responsibilities:
1.
Technical Documentation
Software &
- Platform:
- Create and maintain comprehensive documentation for the iPUMPNET cloud platform, including:
1.
Software Requirements
Specifications (SRS) and Functional Specifications
2.
System
Architecture documents and component design documentation
- REST API documentation (OpenAPI/Swagger or similar) for iPUMPNET's integration interfaces
- Database schema documentation and data dictionary
- Release notes, change logs, and software version control documentation
2.
Technical Documentation
Hardware &
- Embedded Systems:
- Document PAPL's industrial data acquisition hardware and embedded systems, including:
- Hardware design specifications, bill of materials, and assembly guides
- Firmware documentation architecture, configuration, and update procedures
- Industrial protocol specifications (MQTT, Modbus, RS-485, REST) and integration guides
- Equipment installation and commissioning manuals for field engineers
- Translate complex hardware and electronics engineering content into explicit, accurate documentation accessible to both technical and operational audiences.
3. AI/ML &
- Data Documentation:
- Document AI/ML models, algorithms, and analytics methodologies including model cards, feature descriptions, validation results, and performance benchmarks.
- Create data dictionaries, data schema documentation, and pipeline architecture documents.
- Document data governance policies, data lineage, and retention policies aligned to PAPL's compliance requirements.
4. User &
- Operations Documentation:
- Write end-user documentation for utility operators, field engineers, and enterprise managers including:
- iPUMPNET web application user manuals and quick-start guides
- Mobile O&M; application user guides
- Operator runbooks and standard operating procedures (SOPs) for pumping station monitoring
- Alarm management and incident response guides
- Design and maintain an organized, searchable documentation portal or knowledge base for internal and external users.
5. ISO &
- CMMi Compliance Documentation:
- Own the documentation framework required to support PAPL's ISO certification and CMMi process maturity goals including:
1.
Quality Management
System (QMS) documentation aligned to ISO 9001
- Applicable technology-related documentation aligned to other standards like ISO 14001, ISO 27001 and ISO 45001
- Process definition documents, work instructions, and procedure guides
- Audit trails, review records, and document control registers
- Configuration management documentation
- Establish and enforce document versioning, review, approval, and archival workflows across PAPL's technology organization.
- Liaise with the QA team and technology leads to ensure documentation remains current and accurately reflects implemented systems at all times.
6. Project &
- Process Documentation:
- Maintain project documentation artefacts project plans, meeting minutes, decision logs, risk registers, and status reports in collaboration with the Scrum Master and project leads.
- Document vendor and sub-contractor integration specifications, interface agreements, and delivery protocols.
- Create onboarding documentation packages for new team members across all technology departments.
Required Qualifications &
- Experience:
Education:
- Bachelor's or Master's degree in Engineering, Computer Science, Technical Communication,
or a related field.
- Certification in Technical Writing (e.g., Society for Technical Communication) or ISO 9001 Internal Auditor a plus.
Experience:
- 4-8 years of technical writing experience, with at least 3 years documenting complex engineering or industrial technology products.
- Demonstrable experience writing documentation to ISO or CMMi standards compliance documentation, process definitions, or QMS artefacts.
- Experience with API documentation tools (Swagger/OpenAPI, Postman, ReadMe or similar) preferred.
- Experience in IoT, embedded systems, industrial automation, or utility technology domains a significant advantage.
- Familiarity with AI/ML concepts sufficient to accurately document models, pipelines, and analytics outputs.
Technical Skills &
- Tools:
- Documentation: MS Word, Confluence, Notion, MkDocs, or Docusaurus
- API Docs: Swagger/OpenAPI, Postman, ReadMe or equivalent
- Diagramming: Draw.io, Lucidchart, Visio, or equivalent for architecture and process diagrams
- Version Control: Git-based documentation workflows (GitHub, Azure DevOps)
- Markup: Markdown, reStructuredText, AsciiDoc or equivalent
- Technical reading ability: Comfortable reading C, C , C#, Python, and SQL code sufficiently to document it accurately not expected to write production code
Skills &
- Mindset:
- Exceptional written English clear, precise, and audience-appropriate across operator manuals, API references, and compliance documents.
- Highly organized with strong document control discipline you treat documentation as a living system, not a one-time artefact.
- Technically curious you dig into systems, ask engineers smart questions, and accurately represent what you learn.
- Proactive documentation advocate you notice when documentation gaps are creating organizational risk and act on them.
📌 Technical Writer - API Documentation (India)
🏢 Derive Management Solutions
📍 India