Technical Writer - Docs-as-Code and Software Documentation (Human)

Neura Robotics GmbH
Metzingen, Germany
3 months ago

Role details

Contract type
Permanent contract
Employment type
Full-time (> 32 hours)
Working hours
Regular working hours
Languages
English, German
Job source

Tech stack

Application Programming Interfaces (APIs) Confluence JIRA C++ (Programming Language) Software Documentation Collaborative Software Communications Protocols Continuous Integration Ethernet EtherCAT Python (Programming Language) Knowledge Management
+13 more
Microsoft Office Modbus Markdown Microsoft SharePoint Software Engineering Toolchain Extensible Markup Language (XML) Robot Operating System Doxygen Git Sphinx Schema ST4 Programming Languages

Job description

  • Preparation of high-quality, standards-compliant technical documentation in English (e.g., operating, assembly, repair, and maintenance instructions)
  • Structured creation, maintenance, and further development of modular content in the XML-based content management system Quanos Schema ST4
  • Development and further optimization of efficient information architectures and documentation structures
  • Creation of translation-friendly content and support of the translation and localization process
  • Close collaboration with interdisciplinary, cross-site teams throughout the product development process
  • Use of modern collaboration and knowledge-management tools: Confluence, Jira, Teams, SharePoint

Your focus tasks:

  • Building, maintaining, and further developing a Docs-as-Code framework (e.g., Git, Markdown, reStructuredText, CI/CD-based publication processes) for development teams, including templates, guidelines, and review processes
  • Creating or contributing to code-related documentation, such as API references and interface specifications
  • Using and integrating technologies such as Sphinx, Doxygen, Breathe, or comparable tools to document technologies like Python, C++, and ROS or industrial communication protocols like Modbus, Profinet, EtherNet/IP, EtherCAT
  • Harmonizing ST4-based content with Docs-as-Code workflows in the future
  • Close collaboration with software developers and Product Owners to ensure technical accuracy

Requirements

Do you have experience in XML?, * Training as a Technical Writer, a comparable qualification, or specialization in a relevant field

  • Alternatively: technical degree or graduation from a technical college
  • Professional experience in technical documentation or in a comparable software-engineering environment (e.g., software development, API/Developer documentation)
  • Very good command of English (main documentation language); good German skills desirable
  • Experience with content management systems (preferably Quanos Schema ST4), XML, and modular documentation
  • Confident use of MS Office and modern collaboration tools (Confluence, Jira, Teams, SharePoint)
  • Strong writing skills and the ability to prepare complex technical content accurately and clearly
  • Knowledge of relevant standards (Machinery Directive, VDI guidelines)
  • Structured, independent working style and strong communication skills
  • Experience with Docs-as-Code (Git, Markdown, reStructuredText, CI/CD workflows)
  • Knowledge in the creation of code-related documentation (APIs, interfaces)
  • Confident use of Sphinx, Doxygen, Breathe, or similar toolchains
  • Understanding of programming languages such as Python, C++, ideally ROS and industrial communication protocols like Modbus, Profinet, EtherNet/IP, EtherCAT
  • Ability to build and maintain an internal documentation framework (templates, guidelines)
  • Experience in robotics or related mechatronics/automation environments is desirable

Apply for this position

This job is hosted externally. Click below to view the full posting and apply.

Apply on indeed.com

Good distractions

Talks and stories from around this role — technically off-topic, practically not.

3:33 min

Generating information-oriented reference documentation directly from source code

Anastasiia Tymoshchuk · WWC 2023

3:05 min

Integrating an assistant application with Jira software

Felix Augenstein · LIVE

6:21 min

Investigating push inefficiencies with upstream Git experts

Jonathan Creamer · Coffee With Developers

1:44 min

Introduction to humanizing your technical documentation

Carolyn Stransky · WWC 2022

5:47 min

Integrating user stories and test automation via Jira tools

Christoph Ruggenthaler · LIVE

1:58 min

Designing technical documentation for cross-functional audiences

Simon Lasselsberger · WWC 2022

Videos

See all

Related articles

See all