As an Asian saying goes, it is better to see something once than to hear about it a thousand times. When somebody describes you some concept you can try to imagine each tiny detail, every piece of the whole, each brick in the wall, but there is always a thing that somehow slips your mind.
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.
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!
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.
Why do we perceive some applications as clear, organized, and easy to use? How to phrase UI content in a way that supports the overall style of the development platform? Well, I’ve learned some great points from a fascinating lecture given by Bohdan Hrechanovskyi –– MacPaw UX copywriter. Continue reading
Most technical communicators I know can be divided into 2 types.
There are the ones who love creating general About/Welcome sections in their docs and get off on illustrating workflows, business value, etc.
And then, the ones who need a whole cake and then some to coax themselves into writing overviews and designing diagrams. It’s much easier for this type to write instructions about tangible, down-to-earth, even techy stuff.
My friend Viktoria Bezsmolna is the definitive type 1. Still, this free-spirited girl landed in our InfoDev department. But soon enough, she eloped to marketing. And then to PR. Now, she is a freelance writer and has her own blog – yay!
I finally decided to get to the bottom of how this journey worked out for her.
Our 1,5-hour interview was very thought-provoking, and here’s how it all summed up in my head.