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

Advertisements

Diagram Series: Common Mistakes

When creating diagrams, you may overlook some tiny, but crucial drawing details. And only after the review, you understand how important these details are. In this article, I will explain some of the most common mistakes when creating diagrams and how to escape them.

Continue reading

Screencasting checklist for beginners

When you are new to the screencasting topic, starting working on your first screencast is a pretty challenging task. We’d wish that it was as easy as just recording the screen. However, fortunately, “I’ve done the procedure million times and I won’t screw it up!” – say no professional anyone. The good movies we see on the big screen are that good because nothing was done on the fly. The amount of time that people spend before the cameras actually start rolling is tremendous. Of course, we are not in Hollywood here, but why should we set for worse?

As a newbie myself, I have some fresh knowledge (and many hours of research), so I tried to summarize some tips, which will make your first experience with screencasting a smoother ride.

The question we all have – so, where do I begin? Continue reading

MadCap Flare: pain points and solutions (part 2)

Using MadCap Flare, a help authoring tool, can be cool and unbearable at the same time. Those InfoDevs who deal with it on a regular basis will definitely understand what I mean. The more I work with this tool, the more I learn about its capabilities and pitfalls. The work on multiple print outputs and the HTML5 target makes the challenge even more exciting. Previously, I shared some issues I encountered with possible solutions for them (See MadCap Flare: pain points and solutions). In this article, I have prepared another portion of troubles to be considered.  So, Ready Steady Go!

Continue reading

Diagram Series: The role of text

A well-drawn diagram communicates a very clear and direct message. You, as an Information Developer, can explain to users the workflow, interrelationship among components, or data exchange through visual assets. Diagrams are not just about cool shapes and trendy colors, but also about the meaning—text. In this article, I will share some important rules how to phrase, format, and position the text in a diagram to make it look more distinct and professional.

Continue reading

Stay trendy in the technical communication world

The world of technical communication is closely intertwined with the advancements in technologies and ways of doing business. The dynamism of the Information Developer profession presupposes that your ability to initiate and embrace the change will greatly help you in achieving a truly innovative approach to your work. This thought prompted me to do a little investigation on technical writing trends of 2018 to familiarize myself with the state of affairs in the industry. After all, forewarned is forearmed, right? Continue reading