Temporary Technical Writer (Contract)
💡 申请小贴士: 点击下方按钮会跳转到 Braintrust 官网申请。完全免费,同时也支持我们平台运营。
⚠️ 翻译说明: 本职位信息由AI翻译,如有任何不准确或歧义之处,请以英文原版为准。
Role Overview
We are seeking a to support multiple R&D-driven documentation projects, including software release documentation such as user's guides and release notes. This role works closely with engineering and product teams to translate technical information into clear, accurate, and user-focused documentation.
The contractor will work approximately 20 hours per week with an expected 1-2 year commitment. Work will be led and guided by an in-house, experienced technical writer, providing onboarding, direction, standards, and review support. Document is authored and published using MadCap Flare, Adobe Indesign, or Adobe Illustrator (legacy QRGs).
Duties & Responsibilities
Project-Based Technical Documentation
- Develop, update, and maintain technical documentation in support of R&D
initiatives, including: o Software release user guides and release notes
o Hardware quick reference guides and setup documentation
o Feature, configuration, and troubleshooting documentation
- Product documentation based on inputs such as design specifications, Jira tickets,
code comments, and SME interviews.
Collaboration with R&D and Product Teams
- Work under the guidance of the in-house technical writer to execute documentation
plans and priorities.
- Collaborate with engineers, QA, and product managers to gather technical details
and validate accuracy.
- Participate in project kickoffs, reviews, and release milestones as needed.
Content Development in MadCap Flare
- Author and structure content in MadCap Flare using established templates, styles,
and best practices.
-
Apply topic-based authoring, reuse, and conditional content where appropriate.
-
Ensure content aligns with existing navigation, publishing workflows, and
documentation standards
Editing, Review, and Release Support
-
Update existing documentation to reflect new features, fixes, or hardware revisions.
-
Incorporate feedback from the in-house technical writer and other stakeholders.
-
Support documentation readiness for software and hardware releases.
Light Technical Maintenance
- Maintain internal links, references, and formatting consistency within assigned
documentation sets.
-Identify gaps or outdated content and raise recommendations to the in-house technical writer.
Knowledge Transfer & Documentation Standards
- Follow established documentation standards and contribute to continuous
improvement.
- Provide handoff notes and context for documentation updates to support team
continuity
Engagement Details
-
Time Commitment: Approximately 20 hours per week
-
Duration: 1-2 year temporary contract
-
Authoring Tool: Madcap Flare
-
Reporting / Guidance: Led by an in-house, experienced technical writer
-
Work Model: Project-based assignments aligned with active R&D efforts
-
Collaboration: Regular interaction with engineering and product teams; brief
weekly check-ins
- Primary Focus: Technical writing and release documentation (not marketing or UX
content)
Required Skills & Experience: - 1-3+ years of experience in technical writing, preferably supporting software and/or
hardware products.
-
Experience creating user guides and release documentation.
-
Working knowledge of MadCap Flare, Adobe desktop publishing tools
(Indesign/Illustrator), Git version control, and Jira issue tracking platform.
-
Ability to quickly understand technical concepts and communicate them clearly.
-
String attention to detail and ability to manage multiple documentation tasks.
-
Comfortable working under guidance and incorporating editorial feedback.
获取个性化职位推送