Category: Technical Writing

Documentation, Technical Writing

REST API Experience

Włodzimierz Gontarz

Regarding some latest experiences, I had a wonderful chance to support SAP with creating globally-available public REST API documentation for a set of micro services for cloud-based commerce solutions – and to bring my consultancy in technical writing for all members of the teams working according to the scrum agile methodology. That was exciting and challenging to interact with both fully co-located teams as well as multinational, geographically-spread (Gliwice, Omsk, Munich), multicultural scrum teams and other remote collaborators in Montreal, Quebec and Boulder, Colorado.

For technical author, well, for any author, everyday day is like a brand new one, and that’s just one of many things that make it cool enough to always feel excited and inspired. I could only wish everybody feels that way, too. Surely, it is worth a try. This feeling comes with every new word, sentence, paragraph, and story…

Technical Writing

Simple story

Włodzimierz Gontarz

1. A misty day
There was a typical misty autumn day in Warsaw when I knocked on the door asking if they are in need of a technical writer. I did not have any knowledge about it, no experience at all. Words like stakeholders, information architecture, versioning, virtualization, webservices, API, JAVA, REST, seemed like taken from the language I would never know.
Yet they trusted my motivation, willingness to learn and contribute. The first months were constant learning: the company, product, and technicalities of writing. After a year, I thought I knew everything. After another year, I realized I did not.

2. Vltava River
In Prague I met people from various countries, cultures, of ten different languages or more. Working with new technologies, requirements, I expanded both profesionally and personally, but continued my never-ending quest for understanding.

3. Quiet haven
I found a quiet haven in a small town. Once more, new tools, new formats, new topics, new tech, new organizational structures. Time of hard work, but also meditation, reflection, and deep mindfulness. What does it take to be the right TW-person in the right place?

4. The sea of opportunities
By now you already know the answer: something common. Helping others to understand technology, product, and above all the idea. The goal is people and their motivation, excitement, willingness to grow and improve.
Your customers go on a journey with you; they purchase from you, but what they also need to make the most of this experience is information. In the waste sea of digital waters, they need clear and concise navigation.