{"id":12502,"date":"2021-07-19T14:09:01","date_gmt":"2021-07-19T18:09:01","guid":{"rendered":"https:\/\/blogs.sw.siemens.com\/solidedge\/?p=12502"},"modified":"2021-10-20T18:11:39","modified_gmt":"2021-10-20T22:11:39","slug":"creating-high-quality-product-documentation-with-solid-edge-technical-publications","status":"publish","type":"post","link":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/creating-high-quality-product-documentation-with-solid-edge-technical-publications\/","title":{"rendered":"Creating high-quality product documentation with Solid Edge Technical Publications"},"content":{"rendered":"\n<p>Have you ever assembled a piece of IKEA furniture? Did you build LEGO sets as a kid, (which is an absolutely respectable adult hobby as well)? If yes, you\u2019re no stranger to technical publications. If you\u2019ve followed a user manual of any kind in your life, you too have been exposed to the basics of technical publications.<\/p>\n\n\n\n<p>If you\u2019re an product designer or engineer, you\u2019ve probably spent some time creating or reviewing product documentation. And if your job is like most in the industry, you probably aren\u2019t able to dedicate as much time to it as you\u2019d like to, especially if you\u2019re managing multiple projects and juggling tight deadlines.<\/p>\n\n\n\n<p>However, the best product designers, engineers and innovators know that documentation and other technical publications can\u2019t be an afterthought \u2014 they\u2019re an integral part of the product development process. Documentation is an important concern from concept through to when your final product is brought to market. The ability to communicate accurate manufacturing, installation and maintenance procedures for your designs is essential to the performance of the products themselves and the overall success of your business.<\/p>\n\n\n\n<p>The challenge of creating effective documentation is that it needs to have extremely high quality, but also needs to be done quickly. Unfortunately, quality and speed are often competing goals and the impact of not meeting both can be detrimental to your reputation and bottom line.<\/p>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<div class=\"wp-block-media-text alignwide has-media-on-the-right is-stacked-on-mobile\"><figure class=\"wp-block-media-text__media\"><a href=\"https:\/\/www.plm.automation.siemens.com\/global\/en\/webinar\/technical-publications-webinar\/20983\" target=\"_blank\" rel=\"noopener\"><img loading=\"lazy\" decoding=\"async\" width=\"403\" height=\"270\" src=\"https:\/\/blogs.sw.siemens.com\/wp-content\/uploads\/sites\/8\/2019\/09\/Technical-Publications-e1525179703280-403x270.jpg\" alt=\"\" class=\"wp-image-1245 size-full\" srcset=\"https:\/\/blogs.stage.sw.siemens.com\/wp-content\/uploads\/sites\/8\/2019\/09\/Technical-Publications-e1525179703280-403x270.jpg 403w, https:\/\/blogs.stage.sw.siemens.com\/wp-content\/uploads\/sites\/8\/2019\/09\/Technical-Publications-e1525179703280-403x270-300x201.jpg 300w\" sizes=\"auto, (max-width: 403px) 100vw, 403px\" \/><\/a><\/figure><div class=\"wp-block-media-text__content\">\n<p>On-Demand Webinar<\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><a href=\"https:\/\/www.plm.automation.siemens.com\/global\/en\/webinar\/technical-publications-webinar\/20983\" target=\"_blank\" rel=\"noreferrer noopener\">Getting started with technical publications<\/a><\/h3>\n\n\n\n<p>How do you create interactive, compelling technical documentation\u2013directly from a CAD models? In this webinar, you\u2019ll learn how to clearly communicate manufacturing, installation, assembly and maintenance procedures through technical publications.<\/p>\n\n\n\n<div class=\"wp-block-buttons is-layout-flex wp-block-buttons-is-layout-flex\">\n<div class=\"wp-block-button\"><a class=\"wp-block-button__link\" href=\"https:\/\/www.plm.automation.siemens.com\/global\/en\/webinar\/technical-publications-webinar\/20983\" target=\"_blank\" rel=\"noreferrer noopener\">Watch the webinar<\/a><\/div>\n<\/div>\n<\/div><\/div>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2 class=\"wp-block-heading\">The importance of speed: waiting on documentation to go to market<\/h2>\n\n\n\n<p>Creating documentation is often one of the last steps in the product development lifecycle, ensuring documents accurately reflect the final design of the product. But since the process of creating documentation can be so time-consuming, your ship date can be held up by documentation. Ready-to-ship products sitting on the shelf because they&#8217;re waiting on required documentation frustrates your sales team as well as your customers. <\/p>\n\n\n\n<p>Getting to market quickly can mean the difference between a competitive edge and lost revenue. And meeting customer milestones for product delivery can mean the difference between a profit and contractual fees.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Accuracy: when small errors cause big problems<\/h2>\n\n\n\n<p>To speed time-to-market, the natural inclination is to start the process of creating technical documentation earlier so it will be ready when the product is ready. But changes made during late-stage design, or change requests made during manufacturing, can result in differences between the product and its manual. Inaccuracies are not only frustrating to end users \u2013 whether customers or service technicians \u2013 but they can cause incorrect installation, maintenance procedures, and use. <\/p>\n\n\n\n<p>In turn, this can lead to inefficient operation of equipment, as well as more breakdowns and warranty claims.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Clarity: the cost of misunderstanding<\/h2>\n\n\n\n<p>Even when documentation is accurate, lack of clarity can cause downstream mistakes. Inability to interpret documentation, or clearly understand the processes, parts or use of a product, can impact its performance and business success. When product details are not shown sufficiently, clarity can suffer as views and angles are hard to see or labeling is confusing. Errors, omissions and confusion caused by technical publications can result in frustrated customers and negative word-of-mouth, which impacts your bottom line in the form of product returns and reduced sales volume. These are obviously serious pitfalls that successful designers and manufacturers should seek to avoid at every opportunity. <a href=\"https:\/\/solidedge.siemens.com\/en\/resource\/white-paper\/solutions-to-technical-publication-challenges\/\" target=\"_blank\" rel=\"noreferrer noopener\">Our latest technical publications eBook<\/a> explores some of the most common challenges that designers and engineers face in technical publications, as well as a range of software-driven solutions for creating accurate, fast and clear documentation.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Common roadblocks to creating accurate, fast and clear technical publications<\/h2>\n\n\n\n<p>The two most common roadblocks in this discipline are&nbsp;<strong>time&nbsp;<\/strong>and&nbsp;<strong>expertise<\/strong>. Today\u2019s manufacturers are recognizing that clear, accurate images of parts and products are the foundation of high-quality downstream documentation, which is necessary for marketing, manufacturing, maintenance, support and even for consumer use. <\/p>\n\n\n\n<p>The good news is for most parts and assemblies, 3D digital models are created as part of the product development process in the form of computer-aided design (CAD) files. Unfortunately, converting these 3D CAD files into technical documentation can be a painstaking process that requires a great deal of time and know-how.<\/p>\n\n\n\n<div class=\"wp-block-media-text alignwide is-stacked-on-mobile\"><figure class=\"wp-block-media-text__media\"><a href=\"https:\/\/solidedge.siemens.com\/en\/resource\/white-paper\/solutions-to-technical-publication-challenges\/\" target=\"_blank\" rel=\"noopener\"><img loading=\"lazy\" decoding=\"async\" width=\"708\" height=\"920\" src=\"https:\/\/blogs.sw.siemens.com\/solidedge\/wp-content\/uploads\/sites\/8\/2021\/07\/2021-07-15-15_04_26-Siemens-SW-Three-solutions-to-technical-publication-challenges-E-Book-_-Highspot.png\" alt=\"\" class=\"wp-image-12519 size-full\" srcset=\"https:\/\/blogs.stage.sw.siemens.com\/wp-content\/uploads\/sites\/8\/2021\/07\/2021-07-15-15_04_26-Siemens-SW-Three-solutions-to-technical-publication-challenges-E-Book-_-Highspot.png 708w, https:\/\/blogs.stage.sw.siemens.com\/wp-content\/uploads\/sites\/8\/2021\/07\/2021-07-15-15_04_26-Siemens-SW-Three-solutions-to-technical-publication-challenges-E-Book-_-Highspot-462x600.png 462w\" sizes=\"auto, (max-width: 708px) 100vw, 708px\" \/><\/a><\/figure><div class=\"wp-block-media-text__content\">\n<p>eBook<\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><a href=\"https:\/\/solidedge.siemens.com\/en\/resource\/white-paper\/solutions-to-technical-publication-challenges\/\" target=\"_blank\" rel=\"noreferrer noopener\">Three solutions to technical publications challenges<\/a><\/h3>\n\n\n\n<p>Get solutions to common product documentation challenges and explore how Solid Edge Technical Publications makes creating fast, accurate and clear documents easier than ever before.<\/p>\n\n\n\n<div class=\"wp-block-buttons is-layout-flex wp-block-buttons-is-layout-flex\">\n<div class=\"wp-block-button\"><a class=\"wp-block-button__link\" href=\"https:\/\/solidedge.siemens.com\/en\/resource\/white-paper\/solutions-to-technical-publication-challenges\/\" target=\"_blank\" rel=\"noreferrer noopener\">Download the eBook<\/a><\/div>\n<\/div>\n<\/div><\/div>\n\n\n\n<div style=\"height:39px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<p>The task of converting files and managing additional files for documentation purposes usually falls on the already far too busy designer who created the original CAD files. Converting files generally can only be done by someone who has expertise in CAD software. Or, instead of converting the file, the designer has to provide bitmap screen captures of CAD images with a specific orientation to be used as-is or recreated by illustrators. All these projects take designers away from their day-to-day work. As an alternative, some manufacturers are still taking photographs of their physical prototypes or final products to create graphical content. Of course, this means the prototype or product has to be manufactured first, which will have an impact on the overall project timeline.<\/p>\n\n\n\n<p>Creating technical publications has never been easy, but today\u2019s fast-paced design and manufacturing world adds another layer of difficulty to the process. But there is hope. Changes to the technical publication landscape promise to make the lag in technical documentation a thing of the past. Technical publications capabilities embedded in today&#8217;s CAD software applications enable illustrators to start their work early \u2013 in tandem with designers \u2013 and update documentation as the designs change.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Using Solid Edge to solve documentation challenges<\/h2>\n\n\n\n<p>The ability to clearly communicate the correct manufacturing, installation and maintenance procedures for your designs is essential to the performance of your products and the success of your business.&nbsp;<a href=\"https:\/\/solidedge.siemens.com\/en\/solutions\/products\/technical-publications\/\" target=\"_blank\" rel=\"noreferrer noopener\">Solid Edge Technical Publications<\/a>&nbsp;can help you create clear, accurate technical documentation: from simple illustrations for end user manuals to interactive 3D technical documents. <\/p>\n\n\n\n<hr class=\"wp-block-separator is-style-dots\"\/>\n\n\n\n<p>To learn more about Solid Edge,&nbsp;<a href=\"https:\/\/solidedge.siemens.com\/en\/solutions\/products\/technical-publications\/\" target=\"_blank\" rel=\"noreferrer noopener\">visit our website<\/a>&nbsp;or&nbsp;<a href=\"https:\/\/trials.sw.siemens.com\/solid-edge\/\" target=\"_blank\" rel=\"noreferrer noopener\">sign up for a free 30-day trial<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Communicating manufacturing, installation and maintenance procedures of your designs is a critical part of product development. Explore how Solid Edge can help you overcome documentation challenges directly within your CAD models.<\/p>\n","protected":false},"author":30919,"featured_media":13594,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"spanish_translation":"","french_translation":"","german_translation":"","italian_translation":"","polish_translation":"","japanese_translation":"","chinese_translation":"","footnotes":""},"categories":[1,105],"tags":[193,194,3076,31],"industry":[],"product":[439],"coauthors":[590],"class_list":["post-12502","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-news","category-ebook","tag-computer-aided-design-cad","tag-computer-aided-manufacturing-cam","tag-documentation","tag-technical-publications","product-solid-edge"],"featured_image_url":"https:\/\/blogs.stage.sw.siemens.com\/wp-content\/uploads\/sites\/8\/2021\/07\/TechPubsCognasphereHeaderv1.png","_links":{"self":[{"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/posts\/12502","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/users\/30919"}],"replies":[{"embeddable":true,"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/comments?post=12502"}],"version-history":[{"count":5,"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/posts\/12502\/revisions"}],"predecessor-version":[{"id":13595,"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/posts\/12502\/revisions\/13595"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/media\/13594"}],"wp:attachment":[{"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/media?parent=12502"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/categories?post=12502"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/tags?post=12502"},{"taxonomy":"industry","embeddable":true,"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/industry?post=12502"},{"taxonomy":"product","embeddable":true,"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/product?post=12502"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/coauthors?post=12502"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}