Overview
This role supports our global training and documentation strategy with a focus on embedded software systems. You will produce high quality, user-focused technical documentation that supports both internal teams and external customers worldwide. You will work closely with engineering, product, and service teams to translate complex embedded software concepts into clear, concise, and accurate documentation. Your work will contribute to the usability, maintainability, and supportability of our embedded software products.
Responsibilities
* Technical Documentation Development
* Independently create and maintain technical documentation for software systems, including:
* Software architecture overviews
* API references
* Firmware update procedures
* Diagnostic and troubleshooting manuals
* Collaborate with software engineers, system architects, and product managers to gather technical information and ensure documentation accuracy
* Interpret and incorporate technical specifications, software release notes, and source code comments into end-user documentation
* Develop and maintain modular, reusable content structures using topic-based authoring principles
* Ensure documentation complies with relevant standards (e.g., IEC, ISO, EU Machinery Directive) and internal style guides
* Project Involvement
* Participate in agile development cycles, attending sprint planning and review meetings to stay aligned with software release timelines
* Contribute to the planning and estimation of documentation tasks within software development projects
* Coordinate with translation vendors and internal stakeholders to support localization of software documentation
* Content Quality and Maintenance
* Review and edit documentation created by peers to ensure consistency, clarity, and technical accuracy
* Maintain version control and change histories for all documentation assets
* Regularly update documentation to reflect software changes, deprecated features, or new functionality
* Visual and Interactive Content
* Create or source diagrams, flowcharts, and UI screenshots to support technical explanations
* Collaborate with UI / UX teams to document user interfaces and embedded system interactions, and support the development of diagnostic strategies and integrate them into troubleshooting documentation
* Collaborate with external documentation service providers and component suppliers to integrate third-party content
* Contribute to tender documentation and provide effort estimates for documentation deliverables
* Gather feedback from service and training teams to continuously improve documentation quality and usability
Qualifications
* Degree or equivalent experience in Technical Communication, Computer Science, Software Engineering, or a related field
* Willingness to pursue further qualifications in technical writing or embedded systems if not already held
* Team leadership (Ideally)
* Proven experience in working in a largely remote capacity, self-motivated
* Strong understanding of embedded software concepts, including real-time operating systems (RTOS), microcontrollers, firmware, and hardware-software integration
* Familiarity with software development tools and environments (e.g., Git, Jira, Doxygen, Sphinx, Markdown, XML / DITA)
* Ability to read and interpret source code (Python, Java or C++) and technical schematics
* Proficiency in Microsoft Office and documentation tools such as Adobe FrameMaker, MadCap Flare, or similar
Soft Skills
* Excellent written and verbal communication skills with strong attention to detail
* Ability to work independently and manage multiple documentation projects simultaneously
* Strong problem-solving skills and the ability to translate complex technical information into user-friendly content
* Comfortable working in a global, cross-functional team environment
Working Conditions
You can be based anywhere in the UK; from time to time, you may be requested to attend meetings at Hemel Hempstead. Some projects may involve working in secure environments with strict confidentiality requirements.
Diversity & Inclusion
We believe that different perspectives and backgrounds are what make a company flourish. All qualified applicants will receive equal consideration for employment regardless of color, religion, sex, sexual orientation, gender identity, national origin, economic status, disability, age, or any other legally protected characteristics. We are proud to be an inclusive company with values grounded in equality and ethics, where we celebrate, support, and embrace diversity. At no time during the hiring process will Smiths Group, nor any of our recruitment partners ever request payment to enable participation. Avoid fraudulent requests by applying directly through our careers website (Careers - Smiths Group plc).
We\'re growing our team and have 2 positions available for Technical Documentation Writers. The successful applicants will have a proven background in creating and maintaining technical documentation for embedded software systems.
Smiths Detection, part of Smiths Group, is a global leader in security and detection solutions designed to protect people and infrastructure. Our technology provides threat detection and screening solutions for aviation, ports and borders, defence, and urban security.
#J-18808-Ljbffr