{"id":5032,"date":"2023-07-21T10:36:03","date_gmt":"2023-07-21T08:36:03","guid":{"rendered":"http:\/\/techdocs.co.il\/2023\/07\/21\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\/"},"modified":"2024-07-29T12:25:34","modified_gmt":"2024-07-29T12:25:34","slug":"technical-documentation-are-you-all-in-or-just-dabbling-a-little","status":"publish","type":"post","link":"https:\/\/techdocs.co.il\/en\/2023\/07\/21\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\/","title":{"rendered":"Technical Documentation: Are you all-in or just dabbling a little?"},"content":{"rendered":"\n<p class=\"wp-block-paragraph\">When Technology Companies come to me with their self-written manual to read and edit, some of the major obstacles they were not ready or willing to contend with are invariably exposed.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">The natural outcome of a writing process is to find the objective of the procedure and explain it so that inadvertently all other procedures will be better understood.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">If that is the case, then why do we need a complete manual if we can get away with one procedure? I meet a lot of companies who have that mindset. They prefer to present customers with outdated YouTube videos than write it like it is.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">It&#8217;s almost impossible to rewrite something easily &#8211; sometimes it\u2019s more financially smart to write it from scratch &#8211; especially if the important parts are new &#8211; you CAN change the screen and then what? The textual procedure comes to assert the screens \u2013 a 1000 words were saved &#8211; but nobody knows how to use the feature.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">The long and the short of it is &#8211; if you want your manual to be succinct but worth the effort &#8211; let me write it for you.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">We at TechDocs are very motivated to get your users in the know.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><blockquote class=\"wp-embedded-content\" data-secret=\"VVhwQcdl4w\"><a href=\"https:\/\/techdocs.co.il\/\">Home<\/a><\/blockquote><iframe class=\"wp-embedded-content\" sandbox=\"allow-scripts\" security=\"restricted\" style=\"position: absolute; visibility: hidden;\" title=\"&#8220;Home&#8221; &#8212; Techdocs\" src=\"https:\/\/techdocs.co.il\/embed\/#?secret=Bd7B48Ge1J#?secret=VVhwQcdl4w\" data-secret=\"VVhwQcdl4w\" width=\"600\" height=\"338\" frameborder=\"0\" marginwidth=\"0\" marginheight=\"0\" scrolling=\"no\"><\/iframe><\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Why is the write it from scratch methodology a winner?<\/p>\n","protected":false},"author":2,"featured_media":7094,"comment_status":"closed","ping_status":"closed","sticky":true,"template":"","format":"standard","meta":{"footnotes":""},"categories":[5],"tags":[],"class_list":["post-5032","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-technical-marketing-writing"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v28.1 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Technical Documentation: Are you all-in or just dabbling a little? - Techdocs<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/techdocs.co.il\/en\/2023\/07\/21\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Technical Documentation: Are you all-in or just dabbling a little? - Techdocs\" \/>\n<meta property=\"og:description\" content=\"Why is the write it from scratch methodology a winner?\" \/>\n<meta property=\"og:url\" content=\"https:\/\/techdocs.co.il\/en\/2023\/07\/21\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\/\" \/>\n<meta property=\"og:site_name\" content=\"Techdocs\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/profile.php?id=100093560511693\" \/>\n<meta property=\"article:published_time\" content=\"2023-07-21T08:36:03+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-07-29T12:25:34+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/techdocs.co.il\/wp-content\/uploads\/2024\/06\/Subscribe-2-Business-Consultant.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"732\" \/>\n\t<meta property=\"og:image:height\" content=\"447\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"author\" content=\"Mor Getz\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@home\" \/>\n<meta name=\"twitter:site\" content=\"@home\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Mor Getz\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/2023\\\/07\\\/21\\\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/2023\\\/07\\\/21\\\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\\\/\"},\"author\":{\"name\":\"Mor Getz\",\"@id\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/#\\\/schema\\\/person\\\/860af6db4d7f5c9c3e2e44f0b3d3e996\"},\"headline\":\"Technical Documentation: Are you all-in or just dabbling a little?\",\"datePublished\":\"2023-07-21T08:36:03+00:00\",\"dateModified\":\"2024-07-29T12:25:34+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/2023\\\/07\\\/21\\\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\\\/\"},\"wordCount\":219,\"publisher\":{\"@id\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/#organization\"},\"image\":{\"@id\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/2023\\\/07\\\/21\\\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/techdocs.co.il\\\/wp-content\\\/uploads\\\/2024\\\/06\\\/Subscribe-2-Business-Consultant.jpg\",\"articleSection\":[\"Technical\\\/Marketing Writing\"],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/2023\\\/07\\\/21\\\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\\\/\",\"url\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/2023\\\/07\\\/21\\\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\\\/\",\"name\":\"Technical Documentation: Are you all-in or just dabbling a little? - Techdocs\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/2023\\\/07\\\/21\\\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/2023\\\/07\\\/21\\\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/techdocs.co.il\\\/wp-content\\\/uploads\\\/2024\\\/06\\\/Subscribe-2-Business-Consultant.jpg\",\"datePublished\":\"2023-07-21T08:36:03+00:00\",\"dateModified\":\"2024-07-29T12:25:34+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/2023\\\/07\\\/21\\\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/techdocs.co.il\\\/en\\\/2023\\\/07\\\/21\\\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/2023\\\/07\\\/21\\\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\\\/#primaryimage\",\"url\":\"https:\\\/\\\/techdocs.co.il\\\/wp-content\\\/uploads\\\/2024\\\/06\\\/Subscribe-2-Business-Consultant.jpg\",\"contentUrl\":\"https:\\\/\\\/techdocs.co.il\\\/wp-content\\\/uploads\\\/2024\\\/06\\\/Subscribe-2-Business-Consultant.jpg\",\"width\":732,\"height\":447,\"caption\":\"SUBSCRIBE\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/2023\\\/07\\\/21\\\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/home-3\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Technical Documentation: Are you all-in or just dabbling a little?\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/#website\",\"url\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/\",\"name\":\"Techdocs\",\"description\":\"Writing Manuals That Speak\",\"publisher\":{\"@id\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/#organization\",\"name\":\"Techdocs\",\"url\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/techdocs.co.il\\\/wp-content\\\/uploads\\\/2024\\\/05\\\/techdocs-logo.jpg\",\"contentUrl\":\"https:\\\/\\\/techdocs.co.il\\\/wp-content\\\/uploads\\\/2024\\\/05\\\/techdocs-logo.jpg\",\"width\":582,\"height\":116,\"caption\":\"Techdocs\"},\"image\":{\"@id\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/#\\\/schema\\\/logo\\\/image\\\/\"},\"sameAs\":[\"https:\\\/\\\/www.facebook.com\\\/profile.php?id=100093560511693\",\"https:\\\/\\\/x.com\\\/home\"]},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/#\\\/schema\\\/person\\\/860af6db4d7f5c9c3e2e44f0b3d3e996\",\"name\":\"Mor Getz\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/8f7306006ef4c7bd7a1dc0cddc4b4a31e8f7ff18abe7543305b4b5817f72f350?s=96&d=mm&r=g\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/8f7306006ef4c7bd7a1dc0cddc4b4a31e8f7ff18abe7543305b4b5817f72f350?s=96&d=mm&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/8f7306006ef4c7bd7a1dc0cddc4b4a31e8f7ff18abe7543305b4b5817f72f350?s=96&d=mm&r=g\",\"caption\":\"Mor Getz\"},\"url\":\"https:\\\/\\\/techdocs.co.il\\\/en\\\/author\\\/morgetz\\\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Technical Documentation: Are you all-in or just dabbling a little? - Techdocs","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/techdocs.co.il\/en\/2023\/07\/21\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\/","og_locale":"en_US","og_type":"article","og_title":"Technical Documentation: Are you all-in or just dabbling a little? - Techdocs","og_description":"Why is the write it from scratch methodology a winner?","og_url":"https:\/\/techdocs.co.il\/en\/2023\/07\/21\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\/","og_site_name":"Techdocs","article_publisher":"https:\/\/www.facebook.com\/profile.php?id=100093560511693","article_published_time":"2023-07-21T08:36:03+00:00","article_modified_time":"2024-07-29T12:25:34+00:00","og_image":[{"width":732,"height":447,"url":"https:\/\/techdocs.co.il\/wp-content\/uploads\/2024\/06\/Subscribe-2-Business-Consultant.jpg","type":"image\/jpeg"}],"author":"Mor Getz","twitter_card":"summary_large_image","twitter_creator":"@home","twitter_site":"@home","twitter_misc":{"Written by":"Mor Getz","Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/techdocs.co.il\/en\/2023\/07\/21\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\/#article","isPartOf":{"@id":"https:\/\/techdocs.co.il\/en\/2023\/07\/21\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\/"},"author":{"name":"Mor Getz","@id":"https:\/\/techdocs.co.il\/en\/#\/schema\/person\/860af6db4d7f5c9c3e2e44f0b3d3e996"},"headline":"Technical Documentation: Are you all-in or just dabbling a little?","datePublished":"2023-07-21T08:36:03+00:00","dateModified":"2024-07-29T12:25:34+00:00","mainEntityOfPage":{"@id":"https:\/\/techdocs.co.il\/en\/2023\/07\/21\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\/"},"wordCount":219,"publisher":{"@id":"https:\/\/techdocs.co.il\/en\/#organization"},"image":{"@id":"https:\/\/techdocs.co.il\/en\/2023\/07\/21\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\/#primaryimage"},"thumbnailUrl":"https:\/\/techdocs.co.il\/wp-content\/uploads\/2024\/06\/Subscribe-2-Business-Consultant.jpg","articleSection":["Technical\/Marketing Writing"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/techdocs.co.il\/en\/2023\/07\/21\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\/","url":"https:\/\/techdocs.co.il\/en\/2023\/07\/21\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\/","name":"Technical Documentation: Are you all-in or just dabbling a little? - Techdocs","isPartOf":{"@id":"https:\/\/techdocs.co.il\/en\/#website"},"primaryImageOfPage":{"@id":"https:\/\/techdocs.co.il\/en\/2023\/07\/21\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\/#primaryimage"},"image":{"@id":"https:\/\/techdocs.co.il\/en\/2023\/07\/21\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\/#primaryimage"},"thumbnailUrl":"https:\/\/techdocs.co.il\/wp-content\/uploads\/2024\/06\/Subscribe-2-Business-Consultant.jpg","datePublished":"2023-07-21T08:36:03+00:00","dateModified":"2024-07-29T12:25:34+00:00","breadcrumb":{"@id":"https:\/\/techdocs.co.il\/en\/2023\/07\/21\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/techdocs.co.il\/en\/2023\/07\/21\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/techdocs.co.il\/en\/2023\/07\/21\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\/#primaryimage","url":"https:\/\/techdocs.co.il\/wp-content\/uploads\/2024\/06\/Subscribe-2-Business-Consultant.jpg","contentUrl":"https:\/\/techdocs.co.il\/wp-content\/uploads\/2024\/06\/Subscribe-2-Business-Consultant.jpg","width":732,"height":447,"caption":"SUBSCRIBE"},{"@type":"BreadcrumbList","@id":"https:\/\/techdocs.co.il\/en\/2023\/07\/21\/technical-documentation-are-you-all-in-or-just-dabbling-a-little\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/techdocs.co.il\/en\/home-3\/"},{"@type":"ListItem","position":2,"name":"Technical Documentation: Are you all-in or just dabbling a little?"}]},{"@type":"WebSite","@id":"https:\/\/techdocs.co.il\/en\/#website","url":"https:\/\/techdocs.co.il\/en\/","name":"Techdocs","description":"Writing Manuals That Speak","publisher":{"@id":"https:\/\/techdocs.co.il\/en\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/techdocs.co.il\/en\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/techdocs.co.il\/en\/#organization","name":"Techdocs","url":"https:\/\/techdocs.co.il\/en\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/techdocs.co.il\/en\/#\/schema\/logo\/image\/","url":"https:\/\/techdocs.co.il\/wp-content\/uploads\/2024\/05\/techdocs-logo.jpg","contentUrl":"https:\/\/techdocs.co.il\/wp-content\/uploads\/2024\/05\/techdocs-logo.jpg","width":582,"height":116,"caption":"Techdocs"},"image":{"@id":"https:\/\/techdocs.co.il\/en\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/profile.php?id=100093560511693","https:\/\/x.com\/home"]},{"@type":"Person","@id":"https:\/\/techdocs.co.il\/en\/#\/schema\/person\/860af6db4d7f5c9c3e2e44f0b3d3e996","name":"Mor Getz","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/8f7306006ef4c7bd7a1dc0cddc4b4a31e8f7ff18abe7543305b4b5817f72f350?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/8f7306006ef4c7bd7a1dc0cddc4b4a31e8f7ff18abe7543305b4b5817f72f350?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/8f7306006ef4c7bd7a1dc0cddc4b4a31e8f7ff18abe7543305b4b5817f72f350?s=96&d=mm&r=g","caption":"Mor Getz"},"url":"https:\/\/techdocs.co.il\/en\/author\/morgetz\/"}]}},"_links":{"self":[{"href":"https:\/\/techdocs.co.il\/en\/wp-json\/wp\/v2\/posts\/5032","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/techdocs.co.il\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/techdocs.co.il\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/techdocs.co.il\/en\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/techdocs.co.il\/en\/wp-json\/wp\/v2\/comments?post=5032"}],"version-history":[{"count":1,"href":"https:\/\/techdocs.co.il\/en\/wp-json\/wp\/v2\/posts\/5032\/revisions"}],"predecessor-version":[{"id":7401,"href":"https:\/\/techdocs.co.il\/en\/wp-json\/wp\/v2\/posts\/5032\/revisions\/7401"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/techdocs.co.il\/en\/wp-json\/wp\/v2\/media\/7094"}],"wp:attachment":[{"href":"https:\/\/techdocs.co.il\/en\/wp-json\/wp\/v2\/media?parent=5032"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/techdocs.co.il\/en\/wp-json\/wp\/v2\/categories?post=5032"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/techdocs.co.il\/en\/wp-json\/wp\/v2\/tags?post=5032"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}