Zombeck.com

You are here: Home » Blog » Technology » A Take on Technical Documentation

A Take on Technical Documentation

If you’ve ever read technical documentation like a software user guide or the instructions for your coffee maker you know it can be a lot of things, but informative, helpful, engaging, appealing, and a good read aren’t descriptions that necessarily come to mind.

The primary goal of documentation is accuracy. After that it's usually anyone's guess.How it's written, who it's written for, and why it's written are also considerations.

Traditionally documentation, while informative, is far from engaging. Why not provide documentation that readers might find appealing and interesting, rather than something they have to slog through? There's no reason documentation can't be engaging, attractive, and visually appealing. Interactive documentation in Flash or PDF makes it easy for the reader to follow, understand, and retain.

By providing accurate, engaging, and visually appealing documentation readers are more apt to follow along and learn what's in the document and use the information more effectively.

Below are some samples of interactive documentation, click on one of the thumbnails below to see the full document. You can also see these samples in the full portfolio.

Click the images below for samples or check out the Documentation section.

Add comment


Security code Refresh

Other Places You'll Find Me

huffpost.1 masthead_subpages.1 redtape moveyour money.1 headhill.1 shame
pic_RZ

Richard Zombeck

I am a blogger, web designer, and technical writer.

My work has been featured in: Huffington Post, The Hill, MSNBC, and Time.

This site is a portfolio of my work and the services I offer.

My Company website can be seen at www.FLADDAP.com

Contact Me:

Us the form at the bottom of the page or e-mail me at

info@zombeck.com

Contact Me

Fill out the form below and I'll get back to quickly.
Please fill in all the fields and don't forget the last one with the four digit number.

Don't forget to enter the four digit code in the spam field at the end. If you prefer to email me directly you can reach me at info[AT]zombeck[DOT]com






Join Me

facebook_64x64 linkedin_64x64 twitter_64x64 rss_64x64

Twitter

twitter Bird more info...!

Social Stuff