Technical Writer

SUMMARY

This position assists in the creation, organization, and maintenance of technical documentation based on defined product and engineering requirements. Works under general supervision, and as part of a multidisciplinary team, to produce user guides, functional specifications, release notes, and internal technical documents. Uses foundational technical writing skills to translate complex concepts into clear, structured, and accurate documentation while continuing to expand technical knowledge through hands-on collaboration with engineering, product, and QA teams.

ESSENTIAL DUTIES AND RESPONSIBILITIES

1. Creates, edits, and maintains technical documentation, including functional specifications, user guides, developer notes, and internal process documents.
2. Translates technical requirements provided by engineering and product teams into clear, accurate, and human-readable documentation.
3. Participates in requirements reviews, design discussions, and planning sessions to ensure documentation reflects current product direction.
4. Collects and compiles content for software release notes, ensuring clarity, accuracy, and alignment with release timelines.
5. Uses Markdown and AsciiDoc, lightweight markup formats to produce documentation that integrates easily with engineering workflows.
6. Creates and updates text-based diagrams and charts using tools such as Mermaid, PlantUML, or similar systems to visually communicate system architecture and workflows.
7. Utilizes the Git version control system to manage documentation, track changes, and collaborate with development teams.
8. Works with developers, QA engineers, and product leads to clarify technical concepts and ensure documentation accuracy.
9. Helps maintain a structured documentation repository and ensures version consistency across documents.
10. Assists in improving documentation standards, templates, and best practices within the company.
11. Reviews and edits documentation created by team members for consistency, clarity, and style adherence.
12. Supports the creation of customer-facing content by adapting internal documentation for broader audiences when needed.
13. Participates in testing sessions, product demonstrations, and feature walkthroughs to gain first-hand understanding of product functionality.
14. Helps identify gaps in existing documentation and proposes updates or new documents to address them.
15. Follows established security and confidentiality guidelines when producing and storing documentation.
16. Learns and applies basic knowledge of software development and release processes to create accurate and relevant documentation.
17. Develops time management and organizational skills to ensure documentation deliverables meet project deadlines.
18. Works with internal teams to help clarify and document requirements for development purposes.

EDUCATION and/or EXPERIENCE

• Requires a Bachelor’s Degree in Technical Writing, English, Communications, Computer Science, or equivalent related experience.
• 2–3 years of technical writing experience, preferably in a software development environment (professional, academic, or internship experience acceptable).
• Experience writing in Markdown, AsciiDoc, or similar text-based formats.
• Familiarity with the Git version control system is highly desirable.
• Experience with text-based diagramming tools such as Mermaid, PlantUML, or Graphviz is a plus.
• Additional desirable skills include basic understanding of software development processes, API documentation, and tools such as Pandoc and Asciidoctor.

TRAVEL

Ability to travel internationally for customer site training and support. Normal trips range from 1 to 2 weeks.

Salary: $70,000 to $80,000 based on experience.