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

hogwarts houses

User behavior types vs. Hogwarts houses

Earlier this year, I wrote several articles on how to document user personas, Hogwarts style.

Like, there are Gryffindorian how-to steps 1-2-3 good to go pal whoo-hoo you’re done! Or, you can have this very thorough, do-it-at-your-own-pace Hufflepuff tutorials with follow-up tasks that guarantee to put you on your feet. For our Slythery audience, we offer several quick&dirty pro tips, no bull. And yeah, Ravenclaw guys, those appendixes with super-tricky scenarios are for you.

…what a mess of styles, huh? :) Anyhow, choose your house, and I’ll tell you more about what docs you’d enjoy!

On the hush-hush side, I would love to write in an individual fun way for each of those houses. But since my invitation to Hogwarts has not arrived (yet!), for now, I am a Technical Communicator for enterprise software.

So, welcome to my world of neutral writing where jokes are not allowed.

Continue reading

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


Book review: Be a better writer. Tips to improve your writing – no matter what you write!

As Information Developers, we need to perfect the skill of writing well, and the scope of our writing is not limited only by creating technical instructions. We should be equally good at creating web content, articles, or blog posts. Besides, one day we might even need to write some sort of a document that we have never dealt with before, for example, a business report or promo brochure. In this situation, we can spend hours googling and processing tons of contradictory or ill-structured information. Or, get our hands on the book “Be a better writer. Tips to improve your writing – no matter what you write!” by Suzanne Lieurance, saving us time and giving us quick directions.

Continue reading