Api Technical Writer - Curitiba, Brasil - EWAVE DO BRASIL INFORMATICA LTDA

EWAVE DO BRASIL INFORMATICA LTDA

Empresa verificada

Curitiba, Brasil

há 3 semanas

Postado por:

Ana Silva

beBee Recruiter

Descrição

Descrição da vaga:

The Volvo Group is one of the world's leading manufacturers of trucks, buses, construction equipment and marine and industrial engines.

The Group also provides complete solutions for financing and service.

The Volvo Group, with its headquarters in Gothenburg, employs about 100,000 people, has production facilities in 18 countries and sells its products in more than 190 markets.

Objectives of the services, expected results

Provide use case examples that explain the most effective ways to use an API.
Create tutorials about how to use the API through documents, eLearning, and video tutorials.

Describe API functions.

Provide use case examples.

Manage review cycles.
Make arguments in favor of how to use the API and its interactions

Secures integration with ongoing initiatives.

DESCRIPTION OF THE REQUESTED SERVICES
Understand what the reader needs to know to use the API. An API writer works with an API to include sample code, functions, parameters, use cases, endpoints, and error messages.

Service Description

The API technical writer is also expected to

gather feedback from stakeholders to assess their needs and improve technical documents, documentation and material.
plan the writing processes and sets timelines and deadlines.

assess for whom the technical and procedural documentation is intended and adjust tone and technical terms used to meet those needs and to ensure understanding.

either create or work with graphic designers to create diagrams, other visual aids etc. to assist readers in understanding a product or process.

Requerimentos:

Required experience and mandatory skills:

Relevant experience in API Developement
Experience in a position where the responsibilities included technical writing experience
As an API technical writer, you must also know at least one programming language
Understand popular structured data formats and API design, but you can use API technical expertise and an understanding of programming languages to advance web and software productions
Facilitate modeling and analysis of processes and operations from a requirement management perspective or design concepts for API products
Good understanding of solution dependencies and interfaces, securing end-to-end understanding.

English A2 or higher.

Good interpersonal and teamwork skills

Recommended Skills

Programming languages Python, JavaScript, JSON or.

NET
Workshop facilitations

Creating and sharing knowledge

Creating customer value

Soft skills

Proactive attitude

Not afraid to ask questions

Communication skills

Able to interact and cooperate with stakeholders from various segments and levels

Knowledge sharing

Benefícios: