- Experience in Technical Writing for Embedded/IOT Devices Design and Development documents
- Sound Knowledge of Firmware and Software Development Tools/Technologies
- Collaboration and Communication
- MS Word Documentation
- Jira Project Management
- TeamCenter PLM
- Madcap Flare Authoring/CMS
- Indesign- Authoring tool
- Adobe Illustrator
- ArborTex
Good to have:
- SAP For updating/notifying- New material/Bill of material
- Visio
- Engineering Change
Key responsibilities:
- Research and gather information: Conduct research to understand technical concepts, products, and processes by interviewing engineers, developers, and other stakeholders to gather necessary details.
- Content creation: Write and edit technical documentation including user manuals, product specifications, training materials, FAQs, release notes, and online help guides.
- Audience analysis: Tailor content to the appropriate audience level, using clear language and appropriate terminology for both technical and non-technical users.
- Visual aids: Incorporate diagrams, screenshots, flowcharts, and other visuals to enhance understanding and clarity of technical information.
- Collaboration: Work closely with subject matter experts (SMEs) to ensure the accuracy and completeness of technical details within documentation.
- Quality control: Proofread and edit documents to eliminate errors in grammar, syntax, and technical accuracy.
- Content management: Maintain and update documentation to reflect changes in products, processes,
- or regulations.
- Feedback loop: Gather feedback from users and stakeholders to identify areas for improvement and iterate existing documentation.
Required skills for a technical writer:
- Excellent writing and editing skills: Ability to communicate complex technical information in a clear, concise, and engaging manner.
- Technical knowledge: Understanding technical concepts and terminology related to the industry or product area.
- Attention to detail: Meticulous focus on accuracy and consistency in technical documentation.
- Organizational skills: Ability to manage multiple projects and deadlines efficiently.
- Collaboration skills: Effective communication and collaboration with cross-functional teams to gather information and incorporate feedback.
- Technical skills:
- o Familiarity with authoring tools like Microsoft Word, Adobe Acrobat, and potentially content management systems (CMS).
- o Proficiency in authoring tools like Adobe FrameMaker, MadCap Flare, or similar
- o Ability to translate complex technical concepts into clear, understandable language
- o Attention to detail and accuracy
- o Experience with graphic design tools
- Visual design skills: Basic understanding of visual design principles to create effective graphics and layouts.
Work environments:
- Embedded and IOT Devices Design and Development
- Software Development for IOT Devices
Good to Have:
- Knowledge of Technical documentation standards
- IEC/IEEE 82079-1: A documentation standard
- ISO 2651x: Software documentation for target groups
- ISO/AWI 21999: A guideline for improving the quality of translations