Technical Documentation Intern

DigiRecruitx; Mumbai; Sur place; INR 120 000 - 180 000; Plein temps

Résumé du poste

DigiRecruitx is seeking a Technical Documentation Intern to craft clear, accurate docs for industrial automation and motion-control products. You will translate technical implementation details into developer-friendly documentation, working with engineering teams and code samples.

The role involves creating installation, configuration, and troubleshooting guides, diagrams, and release notes, while using Markdown, Git, and documentation toolchains like Sphinx or MkDocs.

Qualifications

• Strong, precise written communication with attention to terminology and clarity.
• Enough C or C++ knowledge to read header files and understand functions.
• Experience with UML and version-controlled workflows.
• Comfort with Markdown-based documentation and Git.
• Experience with diagramming tools such as draw.io or Mermaid.
• Currently studying or recently completed B.E./B.Tech in relevant fields.

Responsabilités

• Write and maintain installation and configuration guides for industrial products.
• Read header files and source code to document APIs and behavior.
• Create diagrams such as network topologies and state machines.
• Prepare release notes and application notes with clear dependencies.
• Test docs by following hardware instructions and identify gaps.
• Maintain docs as code using Markdown in Git and toolchains like Sphinx or MkDocs.
• Help uphold a consistent style guide and glossary across tech docs.

Connaissances

Strong technical writing

C/C++ knowledge

UML

Git & Markdown

Diagramming tools

Attention to detail

Engineering degree background

Formation

B.E./B.Tech in E&TC, Electronics, CS, Instrumentation, Mechatronics

Outils

Sphinx

MkDocs

Doxygen

draw.io

Mermaid

Description du poste

About the Role

We are looking for a Technical Documentation Intern to create clear, accurate, and practical documentation for industrial automation and motion-control products. The role involves working closely with engineering teams and turning technical implementation details into documentation that developers, integrators, and commissioning engineers can use confidently.

This role is ideal for someone who enjoys precise technical writing, understands software and hardware concepts, and is comfortable working with code, diagrams, documentation tools, and version-controlled workflows.

Key Responsibilities

• Write and maintain installation guides, commissioning guides, configuration references, and troubleshooting documentation for industrial control products.
• Read header files and source code to document APIs, expected behaviour, return values, and failure conditions.
• Create technical diagrams such as network topologies, wiring diagrams, timing diagrams, and state machines.
• Prepare release notes and application notes that clearly explain changes, dependencies, and re-testing requirements.
• Test documentation by following instructions on real hardware and identifying missing or unclear steps.
• Maintain documentation as code using Markdown or reStructuredText in Git and documentation toolchains such as Sphinx, MkDocs, or Doxygen.
• Help maintain a consistent style guide and terminology glossary across technical documentation.

Required Skills & Background

• Strong, precise written communication with attention to terminology and clarity.
• Enough C or C++ knowledge to read header files and understand the purpose of functions.
• Experience with UML.
• Comfort with Git, Markdown, and terminal-based workflows.
• Experience with diagramming tools such as draw.io, Mermaid, Inkscape, or equivalent.
• Strong attention to technical detail and willingness to verify specifications before documenting them.
• Currently studying or recently completed B.E. / B.Tech in E&TC, Electronics, Computer Science, Instrumentation, Mechanical, Mechatronics, or a related discipline. Candidates from technical writing, English, or science backgrounds may also be considered if they demonstrate strong technical aptitude.

What Would Make You Stand Out

• Examples of technical documentation such as READMEs, Git documentation, or UML work.
• Exposure to industrial automation, PLCs, CNC machines, robotics, or embedded systems.
• Experience with Sphinx, MkDocs, Doxygen, DITA, or another documentation toolchain.
• Open-source contributions, including documentation-focused pull requests.