{"id":37850,"date":"2021-10-13T17:51:00","date_gmt":"2021-10-13T15:51:00","guid":{"rendered":"https:\/\/fhi.nl\/nieuws\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\/"},"modified":"2024-07-10T13:39:36","modified_gmt":"2024-07-10T11:39:36","slug":"technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen","status":"publish","type":"news","link":"https:\/\/fhi.nl\/en\/news\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\/","title":{"rendered":"Writing technical documentation How do I get off to a good start in 8 steps?"},"content":{"rendered":"<header id=\"header\" class=\"header header--low header--branch\">\n\n\t\n\t\t\t<div class=\"header__background header__background--graphic\"><\/div>\n\t\n\t<div class=\"container\">\n\t\t<div class=\"header__content\">\n\t\t\t<div class=\"header__first header__first--alone\">\n\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t<h1 class=\"header__title\" >\n\t\t\t\t\tWriting technical documentation How do I get off to a good start in 8 steps?\t\t\t\t<\/h1>\n\n\t\t\t\t<div class=\"header__dots-line\">\n\t\t\t\t\t<svg width=\"431\" height=\"9\" viewbox=\"0 0 431 9\" fill=\"none\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\"><path d=\"M430.799 4.192a1.136 1.136 0 1 1-2.272-.001 1.136 1.136 0 0 1 2.272 0Zm-27.272 0a1.135 1.135 0 1 1-2.27 0 1.135 1.135 0 0 1 2.27 0Zm-27.27 0a1.136 1.136 0 1 1-2.272-.001 1.136 1.136 0 0 1 2.272 0Zm-27.272 0a1.39 1.39 0 1 1-2.78 0 1.39 1.39 0 0 1 2.78 0Zm-27.78 0a1.645 1.645 0 1 1-3.29 0 1.645 1.645 0 0 1 3.29 0Zm-28.29 0a1.9 1.9 0 1 1-3.799 0 1.9 1.9 0 0 1 3.799 0Zm-28.799 0a2.154 2.154 0 1 1-4.308 0 2.154 2.154 0 0 1 4.308 0Zm-29.308 0a2.41 2.41 0 1 1-4.819 0 2.41 2.41 0 0 1 4.819 0Zm-29.819 0a2.663 2.663 0 1 1-5.326.001 2.663 2.663 0 0 1 5.326-.001Zm-30.327 0a2.919 2.919 0 1 1-5.837 0 2.919 2.919 0 0 1 5.837 0Zm-30.837 0a3.173 3.173 0 1 1-6.345.001 3.173 3.173 0 0 1 6.345 0Zm-31.346 0a3.428 3.428 0 1 1-6.856 0 3.428 3.428 0 0 1 6.856 0Zm-31.856 0a3.683 3.683 0 1 1-7.365 0 3.683 3.683 0 0 1 7.365 0Zm-32.365 0a3.937 3.937 0 1 1-7.875 0 3.937 3.937 0 0 1 7.875 0Zm-32.874 0a4.192 4.192 0 1 1-8.384 0 4.192 4.192 0 0 1 8.384 0Z\" fill=\"#FFF960\"\/><\/svg>\t\t\t\t<\/div>\n\n\t\t\t\t\n\t\t\t\t\n\t\t\t<\/div>\n\n\t\t\t\n\t\t<\/div>\n\t<\/div>\n<\/header>\n\n\t<div class=\"header__meta\">\n\t<div class=\"container\">\n\t\t<div class=\"header__meta__category\">\n\n\t\t\t\t\t\t\t<div class=\"header__meta__detail\">\n\t\t\t\t\t<div>Branch<\/div>\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<a href=\"https:\/\/fhi.nl\/en\/kennishub\/?_branches_kennishub=industriele-automatisering\" class=\"header__meta__detail--branch\">\n\t\t\t\t\t\t\t\tIndustrial automation\t\t\t\t\t\t\t<\/a>\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\n\t\t\t\n\t\t<\/div>\n\t<\/div>\n<\/div>\n\n<div class=\"text bg--white\">\n\t<div class=\"container\">\n\t\t\t\t\t\t\t\t\t\t\t<div class=\"text__content text__content--1-col\">\n\t\t\t<h2><strong>Writing technical documentation<\/strong><\/h2>\r\n<h2><strong>How do I make a good start in 8 steps?<\/strong><\/h2>\r\n<p>Most people who start writing technical documentation for a product, service or software package are inclined to do this with a tool from Microsoft and Adobe. And mainly with MS Word and InDesign from Adobe.<\/p>\r\n<p>Basically there is nothing wrong with that when it comes to a simple document.<\/p>\r\n<p>Seasoned Word users know how to produce the most beautiful documents, decorated with photos, AutoCAD cutouts and diagrams. The layout is then done in, for example, InDesign. The results are impressive.<\/p>\r\n<p>We at Author-it don&#039;t want to discourage this creative process, but we do give you a few things to think about.<\/p>\r\n<p>Consider the following;<\/p>\r\n<ul>\r\n<li>Where does the content live after it has been created and is it safe there?<\/li>\r\n<li>Where do you adjust the content, and do you also have to work on the layout again?<\/li>\r\n<li>How do you manage the different versions?<\/li>\r\n<li>Can someone change it, whether desired or not?<\/li>\r\n<li>Do you want to, and can you, put so much energy into this creative process every time?<\/li>\r\n<li>Does it need to be translated? And how many languages?<\/li>\r\n<li>In addition to PDF and print, would you also like to use this (adapted) documentation for another medium?<\/li>\r\n<li>What happens when the workload becomes high, how do you divide the work?<\/li>\r\n<li>Can employees participate in the documentation process?<\/li>\r\n<li>What happens if the writer leaves the company?<\/li>\r\n<\/ul>\r\n<p>Anyway, back to what it&#039;s really about, making technical documentation readable.<\/p>\r\n<p><strong>1-Define your target group<\/strong><\/p>\r\n<p>The approach and composition of a text depends on the target group. This seems very obvious, but as a writer you have to read back again and again with the reader of your document in mind. Listening to your target group, analyzing, understanding, asking questions and selecting are essential in this step.<\/p>\r\n<p><strong>2-Write the technical documentation<\/strong><\/p>\r\n<p>Try to use a template so that you can act logically. It is pleasant to work when, as a writer or participant in the writing process, you do not have to think about the layout, layout and structure. Try reapplying previously used text blocks. This speeds up the writing process and ensures consistency of the texts. And last but not least, it significantly reduces translation costs.\u00a0<\/p>\r\n<p>Technical communication continues <a href=\"https:\/\/www.technical-communication.org\/\">tekom Europ<\/a>\u00a0, the European organization for technical writers, defined as the arts <em>of being able to accurately, correctly and effectively convey factual information to certain target groups for specific purposes<\/em>.<\/p>\r\n<p><strong>3-Simplify and reduce the texts<\/strong><\/p>\r\n<p>Even if you think you know your target group well, prevent the reader from dropping out or misinterpreting the text. For example, use few or no abbreviations.<\/p>\r\n<p>When you prepare texts in English, use Simplified Technical English (STE). This is a useful tool to eliminate redundant, difficult and confusing words and phrases from your technical documentation.<\/p>\r\n<p>Some technical documentation is only read during an emergency. (<em>How do I operate the fire extinguisher?<\/em>) Lengthy and vague texts should be avoided. Describe something punctually. Use action items or numbers and keep it short.<\/p>\r\n<p><strong>4-Determine the content of the technical documentation.<\/strong><\/p>\r\n<p>Before you start writing the technical documentation, it is important that you have collected all the information from the experts. Then, the purpose of technical documentation is to tell the user how to use the product safely and correctly.<\/p>\r\n<p>In the EU there are guidelines\/standards for user manuals.<\/p>\r\n<p>Writing user manuals (NEN5509)<\/p>\r\n<p>To meet the requirements of European directives and standards, <strong>must <\/strong>companies create documentation. What needs to be made is;<\/p>\r\n<ul>\r\n<li>The declarations of conformity.<\/li>\r\n<li>The user manual.<\/li>\r\n<li>The technical (construction) file.<\/li>\r\n<li>Work instructions for your own machine park.\u00a0<\/li>\r\n<\/ul>\r\n<p>And in general there are issues that appear in every technical documentation.<\/p>\r\n<ul>\r\n<li>A description of the product<\/li>\r\n<li>Technical specifications<\/li>\r\n<li>Precautionary measures<\/li>\r\n<li>Instructions for installation and commissioning.<\/li>\r\n<li>Maintenance, malfunctions and defects<\/li>\r\n<\/ul>\r\n<p><strong>5-illustrate the technical documentation<\/strong><\/p>\r\n<p>By adding photos or illustrations that support or replace the texts in your technical documentation, the time it takes for a user to learn something and act correctly can be greatly reduced. The amount of text is reduced and partly replaced by images. This not only makes the technical documentation more pleasant and interesting, but it also reduces translation costs.<\/p>\r\n<p><strong>6-Translate the technical documentation<\/strong><\/p>\r\n<p>In many cases, technical documentation also needs to be translated. Sometimes this is done purely to comply with legislation, or because it promotes a user-friendly transfer of information. Regardless of your reasons for having your technical documentation translated, it is important that you engage a translator or translation agency that has the necessary knowledge and expertise in translating<em> technical documentation<\/em>.<\/p>\r\n<p>In any case, the translation agency should support a translation memory of your content and have knowledge of localization. The latter is important for the context in a particular language.<\/p>\r\n<p><strong>7-Prepare the technical documentation<\/strong><\/p>\r\n<p>Once the content of your technical documentation is ready, it is time to neatly format everything and provide it with the correct design. Commonly used software programs for creating technical documentation include Adobe InDesign, or FrameMaker, or the more specifically designed,\u00a0 <a href=\"https:\/\/www.author-it.com\/\">Author-it<\/a> and MadCap Flare.<\/p>\r\n<p><strong>8-Publish the technical documentation<\/strong><\/p>\r\n<p>Providing a paper manual is mandatory for most products.<\/p>\r\n<p>However, this obligation can also be an advantage. For example, a company with good documentation has a much better position in claims and other legal issues.<\/p>\r\n<p>It can also be an advantage to make a digital manual available. These types of manuals, usually in the form of a customer portal or a customer service center, offer the user the opportunity to also consult the technical documentation via computer, tablet or smartphone. The big advantage is that as a supplier you can adjust the information and provide video instructions and animations.<\/p>\r\n<p>But there are more advantages such as;<\/p>\r\n<ul>\r\n<li>An image improvement.<\/li>\r\n<li>Satisfied customers.<\/li>\r\n<li>Good reviews.<\/li>\r\n<li>A less burdened service department.<\/li>\r\n<li>Faster transfer and availability of information.<\/li>\r\n<li>More convenient and better training of new employees.<\/li>\r\n<li>A safe working environment with safer machines.<\/li>\r\n<\/ul>\r\n<p>\u00a0<\/p>\r\n<p>Author-it has a Dutch office and team of experts who can advise you on purchase, use and optimization.<\/p>\r\n<p>Go for more information about Author-it and a demo <a href=\"https:\/\/www.author-it.com\/\">to our website.<\/a>\u00a0 Fill in your details and we will contact you quickly from the Netherlands. <br \/><\/p>\r\n<p>\u00a0<\/p>\t\t<\/div>\n\t<\/div>\n<\/div>\r\n\t<div class=\"articles bg--offwhite automatic\">\r\n\t\t<div class=\"container\">\r\n\t\t\t<div class=\"articles__header\">\r\n\t\t\t\t\t\t\t\t\t<div class='heading-wrapper'><svg width=\"13\" height=\"13\" viewbox=\"0 0 13 13\" fill=\"none\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\"><circle cx=\"6.394\" cy=\"6.5\" r=\"6.394\" fill=\"#000\"\/><\/svg><h2>Related articles<\/h2><\/div>\t\t\t\t\t\t\t\t\t\t\t\t\t<a href=\"\/en\/profiel\/author-it-software-corporation-bv\/\" class=\"button button--outline\">view profile<\/a>\r\n\t\t\t\t\t\t\t<\/div>\r\n\t\t\t\t\t\t<div class=\"post-grid post-grid--no-padding\">\r\n\t\t\t\t\n<a class=\"single-item single-item__articles\" href=\"https:\/\/fhi.nl\/en\/news\/committed-to-quality\/\" data-id=\"43506\">\n\t<div class=\"single-item__articles-icon\">\n\t\t<svg width=\"82\" height=\"98\" viewbox=\"0 0 82 98\" fill=\"none\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\">\n<path fill-rule=\"evenodd\" clip-rule=\"evenodd\" d=\"M26.5586 7.96501C26.5586 6.61879 26.8909 5.49682 27.3233 4.77796C27.7792 4.02009 28.1318 4 28.1466 4H55.0564C55.0712 4 55.4238 4.02009 55.8796 4.77796C56.312 5.49682 56.6444 6.61879 56.6444 7.96501C56.6444 9.31122 56.312 10.4332 55.8796 11.1521C55.4238 11.9099 55.0712 11.93 55.0564 11.93H54.2487C53.8841 11.5449 53.3681 11.3047 52.796 11.3047H28.981C28.5233 11.3047 28.1015 11.4584 27.7644 11.7171C27.6381 11.602 27.4874 11.4248 27.3233 11.1521C26.8909 10.4332 26.5586 9.31122 26.5586 7.96501ZM26.981 15.7683C25.6024 15.3755 24.5619 14.3215 23.8956 13.2138C23.0294 11.7738 22.5586 9.91326 22.5586 7.96501C22.5586 6.01675 23.0294 4.15622 23.8956 2.71619C24.7383 1.31517 26.1797 0 28.1466 0H55.0564C57.0232 0 58.4646 1.31517 59.3073 2.71619C60.1735 4.15622 60.6444 6.01675 60.6444 7.96501C60.6444 9.91326 60.1735 11.7738 59.3073 13.2138C58.4646 14.6148 57.0232 15.93 55.0564 15.93H54.796V40.3243L80.5327 84.0062L80.5391 84.0172L80.5503 84.0368C84.0711 90.2609 79.5954 97.9997 72.4362 97.9997H9.34052C2.18152 97.9997 -2.29415 90.2608 1.22665 84.0368C1.23243 84.0265 1.23831 84.0163 1.24428 84.0062L26.981 40.3243V15.7683ZM30.981 15.93V35.792H39.161C40.2655 35.792 41.161 36.6874 41.161 37.792C41.161 38.8966 40.2655 39.792 39.161 39.792H30.981V40.8697C30.981 41.2268 30.8854 41.5773 30.7041 41.8849L21.3184 57.8149H60.4585L51.0728 41.8849C50.8916 41.5773 50.796 41.2268 50.796 40.8697V15.93H30.981ZM62.8152 61.8148C62.8065 61.8149 62.7978 61.8149 62.7891 61.8149H19.4727C19.3082 61.8149 19.1484 61.7951 18.9954 61.7577L4.70016 86.0205C2.69212 89.5942 5.27194 93.9997 9.34052 93.9997H72.4362C76.5051 93.9997 79.0848 89.5941 77.0768 86.0205L62.8152 61.8148Z\" fill=\"#FFDA56\"\/>\n<\/svg>\n\t<\/div>\n\t<div class=\"single-item__articles-title\"><div class='heading-wrapper'><h3>#Committed to Quality<\/h3><\/div><\/div>\n\t<div class=\"single-item__articles-terms\">\n\t\t\n\t\t\n\t\t\t\t\t\t<span class=\"button button--outline single-item__articles-term--branche single-item__articles-term\">Laboratory Technology<\/span>\n\t\t\t\t\t\t\t\t<span class=\"button button--outline single-item__articles-term--branche single-item__articles-term\">Members content<\/span>\n\t\t\t\t\t<\/div>\n\t<div class=\"single-item__articles-author-date-wrapper\">\n\t\t\t\t\t<div class=\"single-item__articles-author\">\n\t\t\t\tWaters Chromatography BV\t\t\t<\/div>\n\t\t\t\t\t\t\t<div class=\"single-item__articles-date\">\n\t\t\t\tAugust 30, 2019\t\t\t<\/div>\n\t\t\t<\/div>\n<\/a>\n\n<a class=\"single-item single-item__articles\" href=\"https:\/\/fhi.nl\/en\/news\/de-mens-als-sensor\/\" data-id=\"34344\">\n\t<div class=\"single-item__articles-icon\">\n\t\t<svg width=\"108\" height=\"97\" viewbox=\"0 0 108 97\" fill=\"none\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\">\n<path fill-rule=\"evenodd\" clip-rule=\"evenodd\" d=\"M71.1889 19.4317C71.1889 18.8156 70.905 18.2339 70.4193 17.8549C69.9336 17.4759 69.3003 17.3419 68.7027 17.4917L39.0059 24.935C38.1162 25.1581 37.4922 25.9577 37.4922 26.875V37.3931H29.2051C28.1005 37.3931 27.2051 38.2885 27.2051 39.3931V75.9996H31.2051V41.3931H47.895V75.9996H51.895V39.3931C51.895 38.2885 50.9996 37.3931 49.895 37.3931H41.4922V28.4356L67.1889 21.9948V75.9998H71.1889V34.3866H77.4785V75.9995H81.4785V32.3866C81.4785 31.282 80.5831 30.3866 79.4785 30.3866H71.1889V19.4317ZM37.5508 51.9436C37.5508 53.0482 38.4462 53.9436 39.5508 53.9436C40.6554 53.9436 41.5508 53.0482 41.5508 51.9436V48.7891C41.5508 47.6845 40.6554 46.7891 39.5508 46.7891C38.4462 46.7891 37.5508 47.6845 37.5508 48.7891V51.9436ZM39.5508 67.01C38.4462 67.01 37.5508 66.1146 37.5508 65.01V61.8555C37.5508 60.7509 38.4462 59.8555 39.5508 59.8555C40.6554 59.8555 41.5508 60.7509 41.5508 61.8555V65.01C41.5508 66.1146 40.6554 67.01 39.5508 67.01ZM56.7871 51.9436C56.7871 53.0482 57.6825 53.9436 58.7871 53.9436C59.8917 53.9436 60.7871 53.0482 60.7871 51.9436V48.7891C60.7871 47.6845 59.8917 46.7891 58.7871 46.7891C57.6825 46.7891 56.7871 47.6845 56.7871 48.7891V51.9436ZM58.7871 35.5164C57.6825 35.5164 56.7871 34.6209 56.7871 33.5164V30.3618C56.7871 29.2572 57.6825 28.3618 58.7871 28.3618C59.8917 28.3618 60.7871 29.2572 60.7871 30.3618V33.5164C60.7871 34.6209 59.8917 35.5164 58.7871 35.5164ZM56.7871 65.01C56.7871 66.1146 57.6825 67.01 58.7871 67.01C59.8917 67.01 60.7871 66.1146 60.7871 65.01V61.8555C60.7871 60.7509 59.8917 59.8555 58.7871 59.8555C57.6825 59.8555 56.7871 60.7509 56.7871 61.8555V65.01Z\" fill=\"#B14AED\"\/>\n<path fill-rule=\"evenodd\" clip-rule=\"evenodd\" d=\"M96.9545 4H11C7.13401 4 4 7.13401 4 11V66.7273C4 70.5933 7.134 73.7273 11 73.7273H96.9545C100.821 73.7273 103.955 70.5933 103.955 66.7273V11C103.955 7.134 100.821 4 96.9545 4ZM11 0C4.92487 0 0 4.92486 0 11V66.7273C0 72.8024 4.92486 77.7273 11 77.7273H96.9545C103.03 77.7273 107.955 72.8024 107.955 66.7273V11C107.955 4.92487 103.03 0 96.9545 0H11Z\" fill=\"#B14AED\"\/>\n<path fill-rule=\"evenodd\" clip-rule=\"evenodd\" d=\"M38 74H69V97H38V74ZM42 78V93H65V78H42Z\" fill=\"#B14AED\"\/>\n<path fill-rule=\"evenodd\" clip-rule=\"evenodd\" d=\"M23.9082 95C23.9082 93.8954 24.8036 93 25.9082 93L82.0446 93C83.1491 93 84.0446 93.8954 84.0446 95C84.0446 96.1046 83.1491 97 82.0446 97L25.9082 97C24.8036 97 23.9082 96.1046 23.9082 95Z\" fill=\"#B14AED\"\/>\n<\/svg>\n\t<\/div>\n\t<div class=\"single-item__articles-title\"><div class='heading-wrapper'><h3>Man as sensor<\/h3><\/div><\/div>\n\t<div class=\"single-item__articles-terms\">\n\t\t\n\t\t\n\t\t\t\t\t\t<span class=\"button button--outline single-item__articles-term--branche single-item__articles-term\">Building Automation<\/span>\n\t\t\t\t\t\t\t\t<span class=\"button button--outline single-item__articles-term--branche single-item__articles-term\">Digital Building of the Future<\/span>\n\t\t\t\t\t<\/div>\n\t<div class=\"single-item__articles-author-date-wrapper\">\n\t\t\t\t\t<div class=\"single-item__articles-author\">\n\t\t\t\tFHI, Federation of Technology Industries\t\t\t<\/div>\n\t\t\t\t\t\t\t<div class=\"single-item__articles-date\">\n\t\t\t\tNovember 3, 2022\t\t\t<\/div>\n\t\t\t<\/div>\n<\/a>\n\n<a class=\"single-item single-item__articles\" href=\"https:\/\/fhi.nl\/en\/news\/peak-shaving-bij-vodafoneziggo\/\" data-id=\"55257\">\n\t<div class=\"single-item__articles-icon\">\n\t\t<svg width=\"103\" height=\"103\" viewbox=\"0 0 103 103\" fill=\"none\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\">\n<path fill-rule=\"evenodd\" clip-rule=\"evenodd\" d=\"M49.5 98.9587V82.3076C33.3844 81.2758 20.6328 67.878 20.6328 51.5019C20.6328 35.1258 33.3844 21.728 49.5 20.6962V4.04134C24.1941 5.08952 4 25.9365 4 51.5C4 77.0635 24.1941 97.9105 49.5 98.9587ZM53.5 78.2983V61.8096H76.3238C72.5238 70.9498 63.8222 77.5397 53.5 78.2983ZM49.5 78.298V61.8096H26.681C30.4804 70.9484 39.1799 77.5377 49.5 78.298ZM47.0728 57.8096H25.3773C24.8906 55.7865 24.6328 53.6743 24.6328 51.5019C24.6328 37.3358 35.5955 25.7301 49.5 24.7058V37.013H34.0466C33.2709 37.013 32.5653 37.4615 32.2359 38.1637C31.9065 38.8659 32.0128 39.6952 32.5086 40.2916L47.0728 57.8096ZM55.9249 57.8096H77.6274C78.1141 55.7865 78.3719 53.6743 78.3719 51.5019C78.3719 37.3342 67.4068 25.7275 53.5 24.7055V37.013H68.9511C69.7268 37.013 70.4324 37.4615 70.7618 38.1637C71.0912 38.8659 70.9849 39.6952 70.4891 40.2916L55.9249 57.8096ZM53.5 82.3079V98.9587C78.8059 97.9105 99 77.0635 99 51.5C99 25.9365 78.8059 5.08952 53.5 4.04134V20.6959C69.6178 21.7254 82.3719 35.1242 82.3719 51.5019C82.3719 67.8796 69.6178 81.2784 53.5 82.3079ZM0 51.5C0 23.7271 21.9843 1.08883 49.5 0.0381213V0H51.5H53.5V0.0381213C81.0157 1.08883 103 23.7271 103 51.5C103 79.9427 79.9427 103 51.5 103C23.0573 103 0 79.9427 0 51.5ZM38.3102 41.013H64.6875L51.4989 56.8765L38.3102 41.013Z\" fill=\"#2DD881\"\/>\n<\/svg>\n\t<\/div>\n\t<div class=\"single-item__articles-title\"><div class='heading-wrapper'><h3>Peak shaving at VodafoneZiggo<\/h3><\/div><\/div>\n\t<div class=\"single-item__articles-terms\">\n\t\t\n\t\t\n\t\t\t\t\t\t<span class=\"button button--outline single-item__articles-term--branche single-item__articles-term\">Industrial Electronics<\/span>\n\t\t\t\t\t\t\t\t<span class=\"button button--outline single-item__articles-term--branche single-item__articles-term\">Grid congestion<\/span>\n\t\t\t\t\t\t\t\t<span class=\"button button--outline single-item__articles-term--branche single-item__articles-term\">IT Infrastructure<\/span>\n\t\t\t\t\t<\/div>\n\t<div class=\"single-item__articles-author-date-wrapper\">\n\t\t\t\t\t<div class=\"single-item__articles-author\">\n\t\t\t\tFHI, Federation of Technology Industries\t\t\t<\/div>\n\t\t\t\t\t\t\t<div class=\"single-item__articles-date\">\n\t\t\t\tOctober 15, 2024\t\t\t<\/div>\n\t\t\t<\/div>\n<\/a>\n\t\t\t<\/div>\r\n\t\t<\/div>\r\n\t<\/div>","protected":false},"excerpt":{"rendered":"","protected":false},"featured_media":37851,"template":"","branches":[12],"events":[],"secretariat":[],"categories":[],"themes_tax":[],"content_types":[514],"class_list":["post-37850","news","type-news","status-publish","has-post-thumbnail","hentry"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v28.6 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>documentatie schrijven<\/title>\n<meta name=\"description\" content=\"Uitleg waar je op moet letten\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/fhi.nl\/en\/nieuws\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\/\" \/>\n<meta property=\"og:locale\" content=\"en_GB\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"documentatie schrijven\" \/>\n<meta property=\"og:description\" content=\"Uitleg waar je op moet letten\" \/>\n<meta property=\"og:url\" content=\"https:\/\/fhi.nl\/en\/nieuws\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\/\" \/>\n<meta property=\"og:site_name\" content=\"FHI, Federatie van technologiebranches\" \/>\n<meta property=\"article:modified_time\" content=\"2024-07-10T11:39:36+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/fhi.nl\/app\/uploads\/news\/921bc5e13d595a34916829c7280fc51a-287861c0b616a826b2aa4536573d248a5c184e0b-linkedin-cover-laptop.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"1536\" \/>\n\t<meta property=\"og:image:height\" content=\"768\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/fhi.nl\\\/nieuws\\\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\\\/\",\"url\":\"https:\\\/\\\/fhi.nl\\\/nieuws\\\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\\\/\",\"name\":\"documentatie schrijven\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/fhi.nl\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/fhi.nl\\\/nieuws\\\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/fhi.nl\\\/nieuws\\\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/fhi.nl\\\/app\\\/uploads\\\/news\\\/921bc5e13d595a34916829c7280fc51a-287861c0b616a826b2aa4536573d248a5c184e0b-linkedin-cover-laptop.jpg\",\"datePublished\":\"2021-10-13T15:51:00+00:00\",\"dateModified\":\"2024-07-10T11:39:36+00:00\",\"description\":\"Uitleg waar je op moet letten\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/fhi.nl\\\/nieuws\\\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\\\/#breadcrumb\"},\"inLanguage\":\"en-GB\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/fhi.nl\\\/nieuws\\\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-GB\",\"@id\":\"https:\\\/\\\/fhi.nl\\\/nieuws\\\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\\\/#primaryimage\",\"url\":\"https:\\\/\\\/fhi.nl\\\/app\\\/uploads\\\/news\\\/921bc5e13d595a34916829c7280fc51a-287861c0b616a826b2aa4536573d248a5c184e0b-linkedin-cover-laptop.jpg\",\"contentUrl\":\"https:\\\/\\\/fhi.nl\\\/app\\\/uploads\\\/news\\\/921bc5e13d595a34916829c7280fc51a-287861c0b616a826b2aa4536573d248a5c184e0b-linkedin-cover-laptop.jpg\",\"width\":1536,\"height\":768},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/fhi.nl\\\/nieuws\\\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/fhi.nl\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Nieuws\",\"item\":\"https:\\\/\\\/fhi.nl\\\/nieuws\\\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Technische documentatie schrijven Hoe maak ik een goede start in 8 stappen?\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/fhi.nl\\\/#website\",\"url\":\"https:\\\/\\\/fhi.nl\\\/\",\"name\":\"FHI, federatie van technologiebranches\",\"description\":\"Nederlandse branchevereniging voor technologiebranches\",\"publisher\":{\"@id\":\"https:\\\/\\\/fhi.nl\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/fhi.nl\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-GB\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/fhi.nl\\\/#organization\",\"name\":\"FHI, federatie van technologiebranches\",\"url\":\"https:\\\/\\\/fhi.nl\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-GB\",\"@id\":\"https:\\\/\\\/fhi.nl\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/fhi.nl\\\/app\\\/uploads\\\/2024\\\/06\\\/3-e1722349014385.png\",\"contentUrl\":\"https:\\\/\\\/fhi.nl\\\/app\\\/uploads\\\/2024\\\/06\\\/3-e1722349014385.png\",\"width\":732,\"height\":136,\"caption\":\"FHI, federatie van technologiebranches\"},\"image\":{\"@id\":\"https:\\\/\\\/fhi.nl\\\/#\\\/schema\\\/logo\\\/image\\\/\"},\"sameAs\":[\"https:\\\/\\\/www.linkedin.com\\\/company\\\/fhi-federation-of-technology-branches\",\"https:\\\/\\\/www.instagram.com\\\/fhi_nl\\\/\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"writing documentation","description":"Explanation of what to look out for","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:\/\/fhi.nl\/en\/nieuws\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\/","og_locale":"en_GB","og_type":"article","og_title":"documentatie schrijven","og_description":"Uitleg waar je op moet letten","og_url":"https:\/\/fhi.nl\/en\/nieuws\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\/","og_site_name":"FHI, Federatie van technologiebranches","article_modified_time":"2024-07-10T11:39:36+00:00","og_image":[{"width":1536,"height":768,"url":"https:\/\/fhi.nl\/app\/uploads\/news\/921bc5e13d595a34916829c7280fc51a-287861c0b616a826b2aa4536573d248a5c184e0b-linkedin-cover-laptop.jpg","type":"image\/jpeg"}],"twitter_card":"summary_large_image","schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/fhi.nl\/nieuws\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\/","url":"https:\/\/fhi.nl\/nieuws\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\/","name":"writing documentation","isPartOf":{"@id":"https:\/\/fhi.nl\/#website"},"primaryImageOfPage":{"@id":"https:\/\/fhi.nl\/nieuws\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\/#primaryimage"},"image":{"@id":"https:\/\/fhi.nl\/nieuws\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\/#primaryimage"},"thumbnailUrl":"https:\/\/fhi.nl\/app\/uploads\/news\/921bc5e13d595a34916829c7280fc51a-287861c0b616a826b2aa4536573d248a5c184e0b-linkedin-cover-laptop.jpg","datePublished":"2021-10-13T15:51:00+00:00","dateModified":"2024-07-10T11:39:36+00:00","description":"Explanation of what to look out for","breadcrumb":{"@id":"https:\/\/fhi.nl\/nieuws\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\/#breadcrumb"},"inLanguage":"en-GB","potentialAction":[{"@type":"ReadAction","target":["https:\/\/fhi.nl\/nieuws\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\/"]}]},{"@type":"ImageObject","inLanguage":"en-GB","@id":"https:\/\/fhi.nl\/nieuws\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\/#primaryimage","url":"https:\/\/fhi.nl\/app\/uploads\/news\/921bc5e13d595a34916829c7280fc51a-287861c0b616a826b2aa4536573d248a5c184e0b-linkedin-cover-laptop.jpg","contentUrl":"https:\/\/fhi.nl\/app\/uploads\/news\/921bc5e13d595a34916829c7280fc51a-287861c0b616a826b2aa4536573d248a5c184e0b-linkedin-cover-laptop.jpg","width":1536,"height":768},{"@type":"BreadcrumbList","@id":"https:\/\/fhi.nl\/nieuws\/technische-documentatie-schrijven-hoe-maak-ik-een-goede-start-in-8-stappen\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/fhi.nl\/"},{"@type":"ListItem","position":2,"name":"Nieuws","item":"https:\/\/fhi.nl\/nieuws\/"},{"@type":"ListItem","position":3,"name":"Technische documentatie schrijven Hoe maak ik een goede start in 8 stappen?"}]},{"@type":"WebSite","@id":"https:\/\/fhi.nl\/#website","url":"https:\/\/fhi.nl\/","name":"FHI, federation of technology industries","description":"Dutch trade association for technology industries","publisher":{"@id":"https:\/\/fhi.nl\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/fhi.nl\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-GB"},{"@type":"Organization","@id":"https:\/\/fhi.nl\/#organization","name":"FHI, federation of technology industries","url":"https:\/\/fhi.nl\/","logo":{"@type":"ImageObject","inLanguage":"en-GB","@id":"https:\/\/fhi.nl\/#\/schema\/logo\/image\/","url":"https:\/\/fhi.nl\/app\/uploads\/2024\/06\/3-e1722349014385.png","contentUrl":"https:\/\/fhi.nl\/app\/uploads\/2024\/06\/3-e1722349014385.png","width":732,"height":136,"caption":"FHI, federatie van technologiebranches"},"image":{"@id":"https:\/\/fhi.nl\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.linkedin.com\/company\/fhi-federation-of-technology-branches","https:\/\/www.instagram.com\/fhi_nl\/"]}]}},"_links":{"self":[{"href":"https:\/\/fhi.nl\/en\/wp-json\/wp\/v2\/news\/37850","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/fhi.nl\/en\/wp-json\/wp\/v2\/news"}],"about":[{"href":"https:\/\/fhi.nl\/en\/wp-json\/wp\/v2\/types\/news"}],"version-history":[{"count":0,"href":"https:\/\/fhi.nl\/en\/wp-json\/wp\/v2\/news\/37850\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/fhi.nl\/en\/wp-json\/wp\/v2\/media\/37851"}],"wp:attachment":[{"href":"https:\/\/fhi.nl\/en\/wp-json\/wp\/v2\/media?parent=37850"}],"wp:term":[{"taxonomy":"branches","embeddable":true,"href":"https:\/\/fhi.nl\/en\/wp-json\/wp\/v2\/branches?post=37850"},{"taxonomy":"events","embeddable":true,"href":"https:\/\/fhi.nl\/en\/wp-json\/wp\/v2\/events?post=37850"},{"taxonomy":"secretariat","embeddable":true,"href":"https:\/\/fhi.nl\/en\/wp-json\/wp\/v2\/secretariat?post=37850"},{"taxonomy":"categories","embeddable":true,"href":"https:\/\/fhi.nl\/en\/wp-json\/wp\/v2\/categories?post=37850"},{"taxonomy":"themes","embeddable":true,"href":"https:\/\/fhi.nl\/en\/wp-json\/wp\/v2\/themes_tax?post=37850"},{"taxonomy":"content_types","embeddable":true,"href":"https:\/\/fhi.nl\/en\/wp-json\/wp\/v2\/content_types?post=37850"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}