Documenting APIs: Open-Source Tools Review

Have you ever been assigned a task to write API documentation, and then you got lost in tools for creating it?

If yes, I would like to share with you amazing research by Diána Lakatos who analyzed loads of info to provide us with a magnificent overview of open-source tools for documenting APIs.

Continue reading

Write The Docs Europe 2016. Takeaways

Ayeeeee @writethedocs again in beautiful Prague!

Thanks to the awesome organizers, speakers, and everyone with whom we talked the days away or even simply clinked glasses – this was a conference to remember!

And just what I remember most, it’s right here in this post.

Continue reading

Finding Inspiration at ETC 2016

It doesn’t come often that one beautiful summer morning you find yourself in a professional environment among quite a number of accomplished specialists of your bread-and-butter sphere. That you have a chance to acquire invaluable knowledge shared by true masters of their craft. That you build a strong network with your international colleagues for the sake of further cooperation, communication, self-development, and career opportunities.

This June, I jumped on a chance to pay a visit to the Evolution of Technical Communication event (ETC 2016) in Sofia, Bulgaria. So little it would be, if I said that speakers were just great delivering their hot-button topics. Diversity of approaches to speech delivering, quite a range of topics to think over, useful workshops, and marvelous networking organizational skills are to pinpoint when giving a feedback about the conference in Sofia.

My special attention though was heavily attracted by the approaches and techniques applied when producing technical developers’ documentation in the microservices environment. The topic was engagingly presented by Lukasz Gornicki, a technical writer in the past and currently a product owner in SAP Hybris, Poland. Lukasz also conducted a very vivid workshop on the REST API documentation the following day.

Related posts

Continue reading

API: Value of Documenting Software Interactions

Have you ever come to realize how interconnected things are in the computer world today? There are dozens of operating systems and piles of applications out there, and their number grows each day at the speed of light. And the greater that number becomes, the more the need for interactivity gets.

Why would we care about software interactions? Well, imagine yourself having a night out with a gang of your pals. And suddenly you all decide to go to the movie tomorrow. The legend says that our ancestors in such cases were concerned about coming to the cinema two hours earlier, staying in line at the box office, and quite often still getting unlucky to run short of tickets available or, at the best case, get the aisle seats of the last row.

Today, we simply open a cinema app on our devices the moment we come up with the idea and become few swipes and a couple of taps away from getting the tickets purchased without even having to print them.

This is called the almighty API in full play.

Continue reading