At a Glance
- Tasks: Create and maintain user-focused technical documentation for embedded software systems.
- Company: Join Smiths Detection, a global leader in security and detection solutions.
- Benefits: Flexible remote work, competitive salary, and opportunities for professional growth.
- Why this job: Make an impact by translating complex tech into clear documentation for global users.
- Qualifications: Degree in Technical Communication or related field; experience with embedded software preferred.
- Other info: Work in a diverse, inclusive environment with excellent career advancement opportunities.
The predicted salary is between 36000 - 60000 Β£ per year.
Get AI-powered advice on this job and more exclusive features.
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.
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.
Job Purpose
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.
Key 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
- Required Skills and Experience
Education & 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
Technical Skills
- 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
- Additional Responsibilities
- 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
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).
Seniority level
- Mid-Senior level
Employment type
- Full-time
Job function
- Information Technology, Manufacturing, and Training
Industries
- Medical Equipment Manufacturing, Aviation and Aerospace Component Manufacturing, and Appliances, Electrical, and Electronics Manufacturing
Note: This description has been refined for clarity and to remove unrelated materials while preserving the core responsibilities and qualifications.
#J-18808-Ljbffr
Technical Documentation Writer employer: Smiths Detection
Contact Detail:
Smiths Detection Recruiting Team
StudySmarter Expert Advice π€«
We think this is how you could land Technical Documentation Writer
β¨Tip Number 1
Network like a pro! Reach out to current or former employees at Smiths Detection on LinkedIn. A friendly chat can give us insider info about the company culture and maybe even a referral!
β¨Tip Number 2
Prepare for the interview by brushing up on your technical knowledge. Make sure we can explain complex embedded software concepts in simple terms. Practice makes perfect, so consider doing mock interviews with friends!
β¨Tip Number 3
Show off your documentation skills! Bring samples of your previous work to the interview. This will help us demonstrate our ability to create clear and concise technical documents that align with what Smiths Detection needs.
β¨Tip Number 4
Donβt forget to follow up after the interview! A quick thank-you email can keep us fresh in their minds and show our enthusiasm for the role. Plus, itβs a great chance to reiterate why weβre the perfect fit!
We think you need these skills to ace Technical Documentation Writer
Some tips for your application π«‘
Tailor Your Application: Make sure to customise your CV and cover letter for the Technical Documentation Writer role. Highlight your experience with embedded software systems and any relevant tools you've used, like Git or Markdown. We want to see how your skills match what we're looking for!
Showcase Your Writing Skills: Since this role is all about creating clear and concise documentation, include samples of your previous work if possible. Whether it's user manuals or API references, we love seeing how you can translate complex concepts into user-friendly content.
Be Clear and Concise: When writing your application, keep it straightforward and to the point. Use bullet points where appropriate and avoid jargon unless it's relevant to the role. We appreciate clarity just as much as you do in your documentation!
Apply Through Our Website: Don't forget to apply directly through our careers website! This ensures your application gets to us without any hiccups. Plus, itβs the best way to stay updated on your application status. We can't wait to hear from you!
How to prepare for a job interview at Smiths Detection
β¨Know Your Tech Inside Out
As a Technical Documentation Writer, it's crucial to have a solid grasp of embedded software concepts. Brush up on your knowledge of real-time operating systems, microcontrollers, and firmware. Be ready to discuss how youβve translated complex technical information into user-friendly documentation in your previous roles.
β¨Showcase Your Collaboration Skills
This role involves working closely with engineering and product teams. Prepare examples of how you've successfully collaborated with cross-functional teams in the past. Highlight any experience you have with agile development cycles, as this will show you're familiar with the fast-paced environment they operate in.
β¨Bring Samples of Your Work
Having tangible examples of your previous documentation can set you apart. Bring along samples that demonstrate your ability to create clear, concise, and accurate technical documents. If possible, include a variety of formats like API references or troubleshooting manuals to showcase your versatility.
β¨Understand Their Standards
Familiarise yourself with relevant standards such as IEC, ISO, and the EU Machinery Directive. During the interview, mention how you ensure compliance with these standards in your documentation. This shows that you not only understand the technical side but also the regulatory aspects of technical writing.