API Technical Writer

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.
• Provide thorough descriptions of an API’s functions and how it interacts with the application.
• 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

• Using knowledge of each API, programming languages, and documenting APIs, create reference documentation for application programming interfaces that help whole teams of developers create better products.
• 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

An application programming interface (API) technical writer creates documents that explain how an API works, the business processes it supports, makes arguments for its usage and creates tutorials and instructions for how to use the API. The API technical writer works closely with internal product experts (such as product managers, programmers and project managers) to learn and understand requirements on the documentation produced.

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.

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

 

- Auxílio Creche para SP
- Cartão Excard
- Crédito Consignado
- Gympass
- Inglês in-company
- Mamães e papais ganham um Cartão Flash (R$ 500,00), no nascimento do baby.
- Plano de saúde (Sulamérica)
- Plano Odontológico
- Seguro de Vida
- VR e/ou VA

CLT Contract