{"id":105,"date":"2026-08-02T06:39:32","date_gmt":"2026-08-02T06:39:32","guid":{"rendered":"https:\/\/www.tomasz-avila.pl\/?p=105"},"modified":"2026-08-03T07:42:33","modified_gmt":"2026-08-03T07:42:33","slug":"how-to-write-technical-documentation","status":"publish","type":"post","link":"https:\/\/www.tomasz-avila.pl\/?p=105","title":{"rendered":"How to write technical documentation"},"content":{"rendered":"\n<p class=\"wp-block-paragraph\">Your reader will get your message clearly when you use <strong>Plain English<\/strong> techniques, those that focus on the audience and where you:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>use everyday English whenever possible<\/li>\n\n\n\n<li>use simple sentence structure\u20142 lines is long enough<\/li>\n\n\n\n<li>use headings and lists\u2014direct the reader\u2019s eye and lead them through the document<\/li>\n\n\n\n<li>use tables\u2014a picture tells a 1000 words<\/li>\n\n\n\n<li>explain technical terms if necessary<\/li>\n\n\n\n<li>use the active voice\u2014\u2018we did it\u2019, not \u2018it was done by us\u2019<\/li>\n\n\n\n<li>use direct speech\u2014\u2018we will\u2019 not \u2018the organization shall\u2019<\/li>\n\n\n\n<li>use lots of white space\u2014the body language of the document<\/li>\n\n\n\n<li>are concise<\/li>\n\n\n\n<li>are positive\u2014\u2018<em>when you send us the form we will\u2026<\/em>\u2019 not \u2018<em>we cannot assist until you return the form<\/em>\u2019<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\">Businesses writing steps<\/h2>\n\n\n\n<ol class=\"wp-block-list\">\n<li>Tell me what you want me to know or do,<\/li>\n\n\n\n<li>Tell me why and how,<\/li>\n\n\n\n<li>Tell me what to do next.<\/li>\n<\/ol>\n\n\n\n<p class=\"wp-block-paragraph\">This approach is quite different from what we were taught at school:<\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li>Introduction<\/li>\n\n\n\n<li>Facts and figures<\/li>\n\n\n\n<li>The conclusion or statement of what you want<\/li>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"<p>Your reader will get your message clearly when you use Plain English techniques, those that focus on the audience and where you: Businesses writing steps This approach is quite different from what we were taught at school:<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-105","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/www.tomasz-avila.pl\/index.php?rest_route=\/wp\/v2\/posts\/105","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.tomasz-avila.pl\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.tomasz-avila.pl\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.tomasz-avila.pl\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.tomasz-avila.pl\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=105"}],"version-history":[{"count":1,"href":"https:\/\/www.tomasz-avila.pl\/index.php?rest_route=\/wp\/v2\/posts\/105\/revisions"}],"predecessor-version":[{"id":106,"href":"https:\/\/www.tomasz-avila.pl\/index.php?rest_route=\/wp\/v2\/posts\/105\/revisions\/106"}],"wp:attachment":[{"href":"https:\/\/www.tomasz-avila.pl\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=105"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.tomasz-avila.pl\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=105"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.tomasz-avila.pl\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=105"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}