Ideas for quality content (summary + video)

Here in Lviv, we were lucky to invite Patrick Keegan, Principal User Assistance Developer at Oracle, and enjoy his talk “Free your mind! And your docs will follow”. It took me some time to digest the whirling ideas and grasp the insights.

In this post, I would like to share two approaches Patrick discussed during his presentation and how I plan to adopt them in my routine as an Information Developer.

Here we go.

Continue reading

Advertisements

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

Video

Microsoft Manual of Style vs. Microsoft Writing Style Guide

Since its first publication in 1995, the Microsoft Manual of Style has been a Holy Grail of editorial wisdom for rookie and experienced tech writers alike.  In January, Microsoft released a new edition—the Microsoft Writing Style Guide. How different are the 2012 version we’ve been relying on for the past few years and the 2018 one? Let’s take a quick glance.

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

Startups don’t need documentation. Stereotype that can cost you

As a startup owner, you care about early validation, seeing if your idea lives or dies. Saving each penny, proving your concept, getting qualified into the race we call market – documentation is the least of your concerns. Heard that, thought that? Me too, but years in product teams and I learnt better –  information can be the bridge between surviving and  thriving.

There are points in your product lifecycle when information can pave the way to product success. The trick  is to pick the right form of documentation and present the information in the most delicious and digestible way.

My assumptions are: your product is usable and smooth in every possible aspect; it brings something new, caters to different types of users, or solves several problems.

Here we go.

Continue reading