Technical Writer

Job summary

Create and maintain developer documentation, user guides, onboarding materials, security hardening guides, and workflow documentation for APIs, Azure services, and a connector framework. Collaborate with engineering, product, and security teams to validate information, publish and organize content, and maintain version control and change logs.

Job details

Responsibilities: Create and maintain developer documentation for REST APIs, GraphQL APIs, and Azure Event Hubs. Write platform user guides, onboarding materials, and security hardening documentation. Document data import and export workflows using JSON and CSV formats. Develop technical content for a connector framework and Azure IoT Hub integrations. Partner with engineering, product, and security teams to gather and validate technical information. Organize and publish content using Markdown, Confluence, and GitHub. Structure documentation for discoverability, usability, and accessibility. Maintain version control and change logs for all documentation updates. Qualifications: Proven experience writing technical documentation for SaaS platforms or developer tools. Strong understanding of REST APIs, HTTP protocols, and GraphQL. Working knowledge of Azure IoT Hub and Azure Event Hubs. Comfort working with JSON and CSV data formats. Proficiency with Markdown, Confluence, and GitHub. Ability to write for technical audiences, including developers and ISVs. Excellent written and verbal communication skills. Strong organizational and project management abilities. Nice to have: smart building or OT/IT data platform experience, security hardening guide experience, a software development or systems integration background, and knowledge of developer experience (DX) principles.

What you’ll do

Create and maintain developer documentation, user guides, onboarding materials, security hardening guides, and workflow documentation for APIs, Azure services, and a connector framework. Collaborate with engineering, product, and security teams to validate information, publish and organize content, and maintain version control and change logs.

Requirements

Requires proven technical documentation experience for SaaS platforms or developer tools, strong knowledge of REST APIs, HTTP, and GraphQL, and working knowledge of Azure IoT Hub and Azure Event Hubs. Candidates should be proficient with JSON, CSV, Markdown, Confluence, and GitHub, and have strong communication, organizational, and project management abilities.

Listed skills

• REST APIs · Preferred
• GraphQL · Preferred
• GitHub · Preferred
• Project management · Preferred

Other relevant skills

Identified from the job description. Confirm important requirements above.

• Technical Writing
• REST APIs
• HTTP Protocols
• GraphQL
• Azure IoT Hub
• Azure Event Hubs
• JSON
• CSV
• Markdown
• Confluence
• GitHub
• Developer Documentation
• Security Hardening
• Technical Communication
• Project Management
• Accessibility

Job areas

• Technology
• Software
• Creative & Media

More jobs from Artech