{"id":488,"date":"2016-10-01T01:57:15","date_gmt":"2016-09-30T17:57:15","guid":{"rendered":"http:\/\/professionalize.it\/?p=488"},"modified":"2019-05-28T11:16:35","modified_gmt":"2019-05-28T03:16:35","slug":"software-documentation","status":"publish","type":"post","link":"https:\/\/professionalizeit.com\/index.php\/2016\/10\/01\/software-documentation\/","title":{"rendered":"Software Documentation – Help your clients find the answers they need."},"content":{"rendered":"

Software Documentation\"software<\/h3>\n

Do your clients need to find answers to your products and want to find them on their own – when they need to, not when your customer support center is open? \u00a0Software documentation online help is a great option to provide to them. \u00a0In this example, the client wanted to ensure their customers had access to both a printed version and an online version. \u00a0It was costly for the client to print manuals and send them to the customer. \u00a0Also, frequent enhancements to the product would make keeping a paper copy current a
\nchallenge.<\/p>\n

Since the client used the software on their retail floor, the client wanted to have small video segments available, but without sound.<\/p>\n

Since the software documentation would only be used from PCs, the client preferred to a more traditional look and feel for the online help. \u00a0This version is not responsive for\u00a0a mobile solution, but it could easily be converted if the needs changed over time.<\/p>\n

Solutions Provided<\/strong><\/h4>\n

With one source document, we can provide an online version where the clients can view step-by-steps. \u00a0We made the printable version available from the home page of the software documentation online help. \u00a0Having a printable option enabled their customers to print the documentation if they preferred to have a printed option.<\/p>\n

You can view a sample of the online help here: \u00a0Sample Non-Responsive Online Help<\/a><\/p>\n

To see the sample of the software documentation in printed format you can see it here: \u00a0Printed Version<\/a><\/p>\n

The short videos provide a visual step for the user to proceed through the software documentation. \u00a0You can view a sample here: \u00a0Sample Video No Audio<\/a><\/p>\n

Development Process<\/h4>\n

The client didn’t have a starting point for their documentation. \u00a0We utilized\u00a0technical\u00a0product requirements documents and revised the content to be end-user friendly. \u00a0The client’s subject-matter-experts provided input and editing to ensure the content written was accurate. \u00a0The material was tested with an end-user group before rollout to ensure the usability of the content was in line with the client’s objectives.<\/p>\n

\"print-document\"Timeframe for Development<\/h4>\n

Since we started with no existing end-user documents and needed screenshots of all of the content, the initial draft took longer. \u00a0In total, we developed the content and went through the review cycles within a month. \u00a0The end-user testing was a few months, and we made small revisions before the client went live with the content.<\/p>\n

Results<\/h4>\n

As a result of the Software\u00a0Documentation, the client found a reduction in customer support calls by 35 percent. \u00a0These results improved over time.<\/p>\n<\/div>

<\/div><\/div><\/div><\/div><\/div>\n","protected":false},"excerpt":{"rendered":"","protected":false},"author":4,"featured_media":407,"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":true,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[6],"tags":[24,45,25],"yst_prominent_words":[68,66,72,63,62,67,59,75,74,70,58,64,65,73,69,56,60,57,71,61],"class_list":["post-488","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-docport","tag-documentation","tag-software-documentation","tag-technical-documentation"],"jetpack_featured_media_url":"https:\/\/i0.wp.com\/professionalizeit.com\/wp-content\/uploads\/2016\/09\/Print-document.png?fit=1255%2C975&ssl=1","jetpack_shortlink":"https:\/\/wp.me\/p82xLK-7S","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/professionalizeit.com\/index.php\/wp-json\/wp\/v2\/posts\/488","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/professionalizeit.com\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/professionalizeit.com\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/professionalizeit.com\/index.php\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/professionalizeit.com\/index.php\/wp-json\/wp\/v2\/comments?post=488"}],"version-history":[{"count":7,"href":"https:\/\/professionalizeit.com\/index.php\/wp-json\/wp\/v2\/posts\/488\/revisions"}],"predecessor-version":[{"id":1808,"href":"https:\/\/professionalizeit.com\/index.php\/wp-json\/wp\/v2\/posts\/488\/revisions\/1808"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/professionalizeit.com\/index.php\/wp-json\/wp\/v2\/media\/407"}],"wp:attachment":[{"href":"https:\/\/professionalizeit.com\/index.php\/wp-json\/wp\/v2\/media?parent=488"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/professionalizeit.com\/index.php\/wp-json\/wp\/v2\/categories?post=488"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/professionalizeit.com\/index.php\/wp-json\/wp\/v2\/tags?post=488"},{"taxonomy":"yst_prominent_words","embeddable":true,"href":"https:\/\/professionalizeit.com\/index.php\/wp-json\/wp\/v2\/yst_prominent_words?post=488"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}