Primary responsibility is to create, edit, and maintain technical documentation like user manuals, installation guides, maintenance procedures, and other related materials, often collaborating with engineering teams to accurately explain complex products or processes to users, ensuring clarity and compliance with industry standards.
Key responsibilities:
Writing and Editing: Develop comprehensive technical documentation, including user manuals, system guides, training materials, and reference manuals, ensuring clear and concise language appropriate for the target audience.
Technical Understanding: Gain in-depth knowledge of products and systems by working closely with engineers, designers, and other technical stakeholders to accurately capture technical details.
Information Gathering: Conduct research, gather information from technical drawings, specifications, and other sources to create accurate documentation.
Visual Aids: Create diagrams, charts, illustrations, and other visual elements to enhance understanding of complex technical concepts.
Standards Compliance: Adhere to industry standards and regulations related to technical documentation, such as S1000D or ATA 100, ensuring consistency and quality.
Collaboration: Work with cross-functional teams to gather feedback, review drafts, and incorporate necessary changes.
Content Management: Utilize authoring tools and content management systems to organize, update, and publish technical documentation efficiently.
Skills:
Excellent written and verbal communication skills
Strong technical understanding of products and systems
Proficiency in authoring tools like Adobe FrameMaker, MadCap Flare, or similar
Ability to translate complex technical concepts into clear, understandable language
Attention to detail and accuracy
Experience with graphic design tools (if needed)
Knowledge of industry standards for technical documentation:
IEC/IEEE 82079-1: A documentation standard
VDI guideline 2770: A guideline for exchanging documents
ISO 2651x: Software documentation for target groups
ISO/AWI 21999: A guideline for improving the quality of translations