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

Advertisements
Link

Storytelling techniques for product documentation

Is storytelling the same as writing well? How to write a concise yet interesting API guide? Is there a way to keep a help system offhand and casual without using humor? All this and much more in my presentation!

Myths about information development: Busted

People tend to create stereotypes about things they don’t have much insight into. I broke into information development from a different industry, and I’d like to share my own experience of mythbusting. 

Before starting my career as an Information Developer, I was a translator and had little awareness of the role and its responsibilities. As a philosopher once said, “Theory without practice is empty”, and I’m glad I got a chance to fill the void and break my stereotypes during the first month of practical experience. Let me share some of them with you. Continue reading

Guide to lightweight docs: layout & structuring tips

Reception of your content largely depends on the first impression that it creates for your audience. Within milliseconds of interaction with your document, your users decide whether this is an instruction that is likely to help them work or make their head hurt.

Discover a few simple illustrated tips on how to style your content in a modern and light way!

Continue reading

7 things to remember when starting a documentation project

Setting up a documentation project from scratch may be quite a challenging task, especially when you do it for the first time. On the one hand, you are excited about the new beginning. But on the other hand, looking for anchors to start the documentation process drives you into despair. Yet, if you start thinking strategically about your content, it may brighten up your life.

Continue reading