Writers.Work

Technical Writer Who Thrives on Explaining Complex Code

Overview
TechnicalContent MarketingFull-timeOn-siteSt. Paul, MN
St. Paul, MN
On-site
Full-time
$75,000 - $95,000 yearly
Technical Writing & Content
21 days ago
Ready to apply?
Take the next step in your career.
Job description

Our engineering division seeks a diligent technical writer to bridge the gap between complex code and user understanding. We need a professional capable of articulating technical specifications into clear, concise documentation for diverse audiences. As a pivotal part of our development cycle, you will collaborate directly with engineers, product managers, and support teams.

Core Responsibilities Include:

  • Documenting Application Programming Interfaces (APIs): Translating intricate code structures and functionalities into comprehensible guides and references, empowering developers to effectively integrate with our products.
  • Crafting User Manuals and Tutorials: Developing comprehensive user guides and interactive tutorials to ensure end-users can proficiently navigate and utilize our systems. These guides must cater to users with varying levels of technical expertise.
  • Creating Internal Knowledge Base Articles: Establishing a comprehensive internal documentation library. Collaborate with subject matter authorities (SMEs) to curate data, resolve known issues, and provide in-depth system walkthroughs.
  • Editing & Improving Current Materials: Evaluate, edit, and revise existing documentation and technical resources. Work to update the materials so that documentation accurately reflect current system behaviors.
  • Collaborate to Define Documentation Standards: Propose style guides and workflows, driving consistency and organization in all documentation deliverables.

Required Professional Attributes:

  • A background in Computer Science, Technical Writing, or related discipline providing an appropriate base for understanding technical processes.
  • Proven experience writing API documentation, user guides, and internal knowledge base articles (3+ years).
  • Ability to read, interpret, and produce code examples (such as JavaScript, Python, or C++).
  • Familiarity with markup languages (e.g., Markdown, HTML) and documentation generation tools (e.g., Sphinx, JSDoc).
  • Ability to function cohesively with developers, product managers, and other teams within a fast-paced and dynamic technological setting.

The Culture & Opportunity:

We are invested in our employee community and pride ourselves on internal development opportunities. In St. Paul, we nurture a positive and inclusive workplace. Benefit options feature: comprehensive health coverage, vision/dental plans, matching 401K offerings, generous paid time-off programs (vacation & parental leave), wellness resources and tuition reimbursement for continuing education.

If simplifying sophisticated concepts excites you, and you thrive in an innovation-driven atmosphere, we invite you to apply.