Aura - Aceleradora de RH
Aura - Aceleradora de RH

Technical Writer (API & SaaS)

July 26, 2025
Full-time
Remote · Florianópolis, Santa Catarina, Brazil
Associate
Front-end Developer

Company: WriteChoice

Location: Remote

Model: MEI/PJ

Who We Are

WriteChoice is a leader in the software and API documentation space, dedicated to helping the world's most innovative tech companies create world-class learning experiences for their users. We believe great documentation is the foundation of a great product. Learn more about us at https://writechoice.io/

Responsibilities

  • Create and maintain clear, accurate API, SDK, and user guide documentation.
  • Collaborate with clients to understand their products, use cases, and user needs.
  • Proactively identify and implement improvements to content, processes, and tools (e.g., Docusaurus, Mintlify, Readme.io).
  • Write detailed API endpoint documentation using the OpenAPI specification, including precise request/response examples.
  • Develop tutorials that simplify complex technical topics for developers and end-users.

Qualifications

  • Proactive and takes initiative to improve processes and deliver client value.
  • A strong sense of ownership, committed to high-quality work and meeting deadlines.
  • Views feedback as an opportunity for growth and can implement it constructively.
  • Curious and driven to learn new technologies and take on challenging projects.
  • An excellent communicator who is responsive, transparent, and engaged with clients and teammates.

Requirements

  • Advanced written and spoken English.
  • Proven experience in technical writing for software and APIs.
  • Demonstrated ability to learn and explain complex technical concepts.
  • Proficiency with Markdown.
  • Experience with Git for version control (GitHub, GitLab, etc.).
  • A solid understanding of how APIs work.

Preferred Qualifications

  • Familiarity with the OpenAPI/Swagger specification.
  • Experience working in an Agile (Scrum/Kanban) environment.
  • Basic knowledge of HTML and CSS.
  • Familiarity with style guides (e.g., Microsoft, Google).

Bonus Points

  • Hands-on experience with documentation-as-code frameworks (Docusaurus, MkDocs) or platforms (Readme.io, Mintlify).
  • Experience with Cloud (AWS, Azure, GCP) and DevOps concepts.
  • Familiarity with frontend frameworks (React, Next.js, Vue).