{"id":10123,"date":"2013-02-11T14:50:53","date_gmt":"2013-02-11T19:50:53","guid":{"rendered":"http:\/\/klishis.com\/notreally\/?p=10123"},"modified":"2013-02-11T15:21:56","modified_gmt":"2013-02-11T20:21:56","slug":"the-importance-of-good-documentation-and-instructions","status":"publish","type":"post","link":"https:\/\/klishis.com\/notreally\/archives\/10123","title":{"rendered":"The Importance of Good Documentation and Instructions"},"content":{"rendered":"

As I’ve mentioned repeatedly, I write technical documentation and instructions–I teach people how to use computer programs.<\/p>\n

Which means that BAD documentation and instructions make me want to hurt someone.<\/p>\n

I’m trying to become familiar with the new online course management system we’ll be moving to, and after a several hours of this, I’d like to take their entire support staff and beat them senselessly.<\/p>\n

My goal: to import questions from a text file of some sort into the program.<\/p>\n

What I found first:<\/p>\n

A very long list of instructional videos. I would rather eat lint WHILE being stabbed with a fork than watch instructional videos.<\/p>\n

Because they are almost always a WASTE OF MY TIME.<\/p>\n

I finally find a help document.<\/p>\n

\"No<\/a><\/p>\n

Completely worthless.<\/p>\n

What I found next (within the program):<\/p>\n

\"No<\/a>
\n\"No<\/a><\/p>\n

OK. Fine. I made a text file.<\/p>\n

It failed. Repeatedly.<\/p>\n

What I finally find after several hours of wasting my time.<\/p>\n

\"Actually<\/a><\/p>\n

Really. Why does the help that pops up WITHIN THE PRODUCT not mention those parentheses? This is a system used across the country–in fact, I believe it’s one of the most used systems.<\/del> So why are their help files so abysmally NOT HELPFUL.<\/p>\n

WHY CAN’T THEY JUST GIVE ME A CLEAR, HELPFUL EXAMPLE?!<\/p>\n

Now if you’ll pardon me, I’m going to go try really hard not to put my fist through my monitor.<\/p>\n

ADDENDUM the FIRST<\/strong>:
\nOK, trying to fix my text file, and I’m now even MORE confused. I really hate technology.<\/p>\n

ADDENDUM the Second<\/strong>:
\nCo-worker looked over everything with me, and we can find no reason why most of the file is failing.<\/p>\n

Have I mentioned how much I hate computers?<\/p>\n","protected":false},"excerpt":{"rendered":"

As I’ve mentioned repeatedly, I write technical documentation and instructions–I teach people how to use computer programs. Which means that BAD documentation and instructions make me want to hurt someone. I’m trying to become familiar with the new online course management system we’ll be moving to, and after a several hours of this, I’d like […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2}},"categories":[17],"tags":[],"class_list":["post-10123","post","type-post","status-publish","format-standard","hentry","category-computers-technology"],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack_shortlink":"https:\/\/wp.me\/pefxA-2Dh","_links":{"self":[{"href":"https:\/\/klishis.com\/notreally\/wp-json\/wp\/v2\/posts\/10123","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/klishis.com\/notreally\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/klishis.com\/notreally\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/klishis.com\/notreally\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/klishis.com\/notreally\/wp-json\/wp\/v2\/comments?post=10123"}],"version-history":[{"count":0,"href":"https:\/\/klishis.com\/notreally\/wp-json\/wp\/v2\/posts\/10123\/revisions"}],"wp:attachment":[{"href":"https:\/\/klishis.com\/notreally\/wp-json\/wp\/v2\/media?parent=10123"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/klishis.com\/notreally\/wp-json\/wp\/v2\/categories?post=10123"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/klishis.com\/notreally\/wp-json\/wp\/v2\/tags?post=10123"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}