{"id":23,"date":"2018-06-24T15:29:00","date_gmt":"2018-06-24T15:29:00","guid":{"rendered":""},"modified":"2021-09-23T13:55:06","modified_gmt":"2021-09-23T13:55:06","slug":"how-to-write-documentation","status":"publish","type":"post","link":"http:\/\/panahy.nl\/index.php\/2018\/06\/24\/how-to-write-documentation\/","title":{"rendered":"How to: Write documentation"},"content":{"rendered":"<p><span face=\"-apple-system, BlinkMacSystemFont, &quot;Segoe UI&quot;, Roboto, &quot;Noto Sans&quot;, Ubuntu, &quot;Droid Sans&quot;, &quot;Helvetica Neue&quot;, sans-serif\" style=\"background-color: white; color: #172b4d; font-size: 1.43em; letter-spacing: -0.01em;\">Questions to ask:<\/span><\/p>\n<ul style=\"background-color: white; color: #091e42; font-family: -apple-system, BlinkMacSystemFont, &quot;Segoe UI&quot;, Roboto, &quot;Noto Sans&quot;, Ubuntu, &quot;Droid Sans&quot;, &quot;Helvetica Neue&quot;, sans-serif; font-size: 14px; margin: 12px 0px 0px; padding: 0px 0px 0px 40px;\">\n<li>Does the document fulfill its purpose?<\/li>\n<li style=\"margin-top: 4px;\">Is anything missing?<\/li>\n<li style=\"margin-top: 4px;\">Can anything be taken out?<\/li>\n<li style=\"margin-top: 4px;\">What questions will the reader have? And answer them.<\/li>\n<li style=\"margin-top: 4px;\">Is the writing easy to understand?<\/li>\n<\/ul>\n<h2 style=\"background-color: white; border-bottom-color: rgb(204, 204, 204); color: #172b4d; font-family: -apple-system, BlinkMacSystemFont, &quot;Segoe UI&quot;, Roboto, &quot;Noto Sans&quot;, Ubuntu, &quot;Droid Sans&quot;, &quot;Helvetica Neue&quot;, sans-serif; font-size: 1.43em; font-weight: normal; letter-spacing: -0.01em; line-height: 1.2; margin: 40px 0px 0px; padding: 0px;\">Also Check:<\/h2>\n<ul style=\"background-color: white; color: #091e42; font-family: -apple-system, BlinkMacSystemFont, &quot;Segoe UI&quot;, Roboto, &quot;Noto Sans&quot;, Ubuntu, &quot;Droid Sans&quot;, &quot;Helvetica Neue&quot;, sans-serif; font-size: 14px; margin: 12px 0px 0px; padding: 0px 0px 0px 40px;\">\n<li>Sentence and paragraph structure<\/li>\n<li style=\"margin-top: 4px;\">Grammar<\/li>\n<li style=\"margin-top: 4px;\">Word choice<\/li>\n<li style=\"margin-top: 4px;\">Spelling<\/li>\n<\/ul>\n<p style=\"background-color: white; color: #091e42; font-family: -apple-system, BlinkMacSystemFont, &quot;Segoe UI&quot;, Roboto, &quot;Noto Sans&quot;, Ubuntu, &quot;Droid Sans&quot;, &quot;Helvetica Neue&quot;, sans-serif; font-size: 14px; margin: 12px 0px 0px; padding: 0px;\"><\/p>\n<p style=\"background-color: white; color: #091e42; font-family: -apple-system, BlinkMacSystemFont, &quot;Segoe UI&quot;, Roboto, &quot;Noto Sans&quot;, Ubuntu, &quot;Droid Sans&quot;, &quot;Helvetica Neue&quot;, sans-serif; font-size: 14px; margin: 12px 0px 0px; padding: 0px;\"><a href=\"https:\/\/app.pluralsight.com\/player?course=technical-writing-software-documentation&amp;author=amber-israelsen&amp;name=technical-writing-software-documentation-m2&amp;clip=5&amp;mode=live\" rel=\"nofollow\" style=\"color: #0052cc; text-decoration-line: none;\">pluralsight &#8211; technical-writing-software-documentation<\/a><\/p>\n<p style=\"background-color: white; color: #091e42; font-family: -apple-system, BlinkMacSystemFont, &quot;Segoe UI&quot;, Roboto, &quot;Noto Sans&quot;, Ubuntu, &quot;Droid Sans&quot;, &quot;Helvetica Neue&quot;, sans-serif; font-size: 14px; margin: 12px 0px 0px; padding: 0px;\"><a data-linked-resource-=\"data-linked-resource-\" data-linked-resource-type=\"page\" data-linked-resource-version=\"1\" href=\"https:\/\/wdev-blog.azurewebsites.net\/index.php\/2018\/06\/24\/writing-that-works\/\" style=\"color: #0052cc; text-decoration-line: none;\">Writing That Works<\/a>&nbsp;<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Questions to ask: Does the document fulfill its purpose? Is anything missing? Can anything be taken out? What questions will the reader have? And answer them. Is the writing easy to understand? Also Check: Sentence and paragraph structure Grammar Word choice Spelling pluralsight &#8211; technical-writing-software-documentation Writing That Works&nbsp;<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[],"uagb_featured_image_src":{"full":false,"thumbnail":false,"medium":false,"medium_large":false,"large":false,"1536x1536":false,"2048x2048":false,"post-thumbnail":false},"uagb_author_info":{"display_name":"Pouya Panahy","author_link":"http:\/\/panahy.nl\/index.php\/author\/pouya\/"},"uagb_comment_info":0,"uagb_excerpt":"Questions to ask: Does the document fulfill its purpose? Is anything missing? Can anything be taken out? What questions will the reader have? And answer them. Is the writing easy to understand? Also Check: Sentence and paragraph structure Grammar Word choice Spelling pluralsight &#8211; technical-writing-software-documentation Writing That Works&nbsp;","_links":{"self":[{"href":"http:\/\/panahy.nl\/index.php\/wp-json\/wp\/v2\/posts\/23"}],"collection":[{"href":"http:\/\/panahy.nl\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/panahy.nl\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/panahy.nl\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/panahy.nl\/index.php\/wp-json\/wp\/v2\/comments?post=23"}],"version-history":[{"count":1,"href":"http:\/\/panahy.nl\/index.php\/wp-json\/wp\/v2\/posts\/23\/revisions"}],"predecessor-version":[{"id":154,"href":"http:\/\/panahy.nl\/index.php\/wp-json\/wp\/v2\/posts\/23\/revisions\/154"}],"wp:attachment":[{"href":"http:\/\/panahy.nl\/index.php\/wp-json\/wp\/v2\/media?parent=23"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/panahy.nl\/index.php\/wp-json\/wp\/v2\/categories?post=23"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/panahy.nl\/index.php\/wp-json\/wp\/v2\/tags?post=23"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}