Hero in you, or how to make your text easier to read

Most of us think that movies and comics are the only places where real heroes dwell. We believe that these mysterious guys just come from nowhere to save the day, and then disappear till the next time when everything goes completely wrong.

But that is not how it actually works. Real heroes surround us, and we meet them every day while commuting, working, or even drinking tea at the nearby restaurant.

Continue reading

Quote

Information Architecture for the World Wide Web

Fellows – Information Developers, Technical Communicators, Information Experts – lend me your ears.
When designing knowledge bases, creating documentation portals, or documenting complex interrelations, one forgotten requirement may result in multiple very memorable working evenings.
Consider this precious advice from Peter Morville and Louis Rosenfeld and always pay heed to these crucial areas.

In short, we need to understand the business goals behind the web site and the resources available for design and implementation. We need to be aware of the nature and volume of content that exists today and how that might change a year from now. And we must learn about the needs and information-seeking behaviors of our major audiences. Good information architecture design is informed by all three areas.

Explore their book Information Architecture for the World Wide Web Peter for more useful tips!

Diagram Series: Decrypting SME’s Drawings

User documentation that includes different types of graphics is more effective and easier to perceive than monotonous text. A diagram is just one type of graphics that prevails mostly in technical documentation. When creating diagrams on a daily basis, you eventually learn to overcome such difficulties as: vague explanations, inaccurate SMEs’ drawings, abundance of details, or lack of information. As an Information Developer, you must know how to combine these diverse chunks to create consistent graphics in user documentation. In this article, I will discuss some tips on decrypting SME’s drawings to make the process of creating diagrams an interesting and creative experience.

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

How to get started with Markdown and where to try it out

Insightful article covering the following important aspects:

  • What is Markdown?
  • How and where to get started with Markdown in documentation?
  • What points to consider?

All things considered, let’s put it that way:

Whereas Markdown is much simpler than HTML or any other markup language, it may introduce a lot of mess to documentation with complicated structure.
On the other hand, it may be quite enough to create simple docs (like, say, Release Notes) on a project.

What do you think?

Source: How to get started with Markdown and where to try it out

https://www.flickr.com/photos/writethedocs/29807686535/in/album-72157674031974295/

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