Technical Writer - Developer Documentation

Position Overview

The role of Technical Writer, Developer Documentation, centers on producing and maintaining comprehensive documentation that supports our developer platform. You will transform complex technical concepts such as APIs, SDKs, hardware interfaces, and communication protocols into clear, reliable reference materials, tutorials, and guides that are practical for developers.

Key Responsibilities

• Compose, revise, and upkeep developer-oriented documentation including API references, integration manuals, quickstart guides, tutorials, and conceptual descriptions.
• Engage directly with source files to make edits, execute scripts, and employ command-line utilities to extract, modify, and publish documentation from codebases.
• Manage the entire documentation infrastructure by building docs locally, resolving pipeline issues, and ensuring consistent and clean output across different formats.
• Design precise technical diagrams such as system architecture layouts, data flow charts, and sequence diagrams to enhance textual content.
• Work closely with engineering teams to gain in-depth system knowledge required for precise documentation and challenge unclear explanations where necessary.
• Review content created by engineers for clarity, thoroughness, and uniformity.
• Develop and maintain a style guide while enforcing documentation standards portal-wide.

Essential Skills and Qualifications

• Strong technical writing skills demonstrating clarity, accuracy, and conciseness without unnecessary jargon.
• Comfortable working within software codebases, including reading and editing source files, executing build scripts, and utilizing Git version control.
• Proficiency with Markdown and awareness of documentation workflows based on docs-as-code principles.
• Capability to comprehend and accurately document code in at least one programming language such as Python, JavaScript, or C.
• Experience creating technical diagrams using tools such as draw.io, Lucidchart, Mermaid, or equivalents.
• Comprehensive understanding of RESTful APIs and fundamental developer tooling concepts.

Preferred Attributes

• Previous involvement in authoring documentation for developer portals, SDKs, or hardware APIs.
• Knowledge of documentation frameworks such as Docusaurus, MkDocs, or Sphinx.
• Familiarity with OpenAPI/Swagger specifications for generating API references.
• Background in robotics, embedded systems, or hardware-related fields.
• Basic scripting skills in Python or Bash for automating documentation tasks.