{"id":2625,"date":"2020-01-31T04:02:57","date_gmt":"2020-01-31T04:02:57","guid":{"rendered":"https:\/\/blog.hassler.ec\/wp\/?p=2625"},"modified":"2019-12-31T06:07:13","modified_gmt":"2019-12-31T06:07:13","slug":"comics-as-documentation","status":"publish","type":"post","link":"https:\/\/blog.hassler.ec\/wp\/2020\/01\/31\/comics-as-documentation\/","title":{"rendered":"Comics as Documentation"},"content":{"rendered":"
\n
\n
\n
\n
<\/div>\n<\/div>\n<\/div>\n<\/div>\n
\n
\n
\n
\n
\n
<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/figure>\n<\/div>\n
\n
\n

Technical writing is not only about boring text. Some technical writers manage to create a user manual in the comics form. If you think that it\u2019s difficult and even impossible, have a look at the following examples.<\/p>\n

IDEA<\/h1>\n
\n
\n
\n
\n
\n
<\/div>\n

<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/figure>\n

IDEA<\/strong>\u00a0is a series of nonverbal algorithm assembly instructions, developed by\u00a0S\u00e1ndor P. Fekete<\/a>\u00a0and\u00a0Sebastian Morr<\/a>. The instructions explain how various popular algorithms work, entirely without text. This also allows the instructions to be understood interculturally.<\/p>\n

\n
\n
\n
IDEA – nonverbal algorithm assembly instructions<\/div>\n
\n
IDEA is a series of nonverbal algorithm assembly instructions, created by S\u00e1ndor P. Fekete and Sebastian Morr.<\/div>\n<\/div>\n
\n
idea-instructions.com<\/div>\n<\/div>\n<\/div>\n
\n
<\/div>\n<\/div>\n<\/section>\n<\/div>\n

Illustrated Guide to OAuth and OpenID Connect<\/h1>\n
\n
\n
\n
\n
\n
<\/div>\n

<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/figure>\n

What is OAuth and OpenID? The answer can sound difficult but there are comics on this topic, so every one will understand this terms.<\/p>\n

\n
\n
\n
An Illustrated Guide to OAuth and OpenID Connect<\/div>\n
\n
In the \u00abstone age\u00bb days of the Internet, sharing information between services was easy. You simply gave your username\u2026<\/div>\n<\/div>\n
\n
developer.okta.com<\/div>\n<\/div>\n<\/div>\n
\n
<\/div>\n<\/div>\n<\/section>\n<\/div>\n

Deploy code faster: with CI\/CD and Kubernetes<\/strong><\/h1>\n
\n
\n
\n
\n
\n
<\/div>\n

<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/figure>\n

Just check out these awesome comics as an example of how fitting they can be in the technical world when used right.<\/p>\n

\n
\n
\n
Deploy code faster: with CI\/CD and Kubernetes | Kubernetes Engine | Google Cloud<\/div>\n
\n
Deploy code faster, protect against outages, and save money using continuous integration and deployment (CI\/CD).<\/div>\n<\/div>\n
\n
cloud.google.com<\/div>\n<\/div>\n<\/div>\n
\n
<\/div>\n<\/div>\n<\/section>\n<\/div>\n

Comics as a Means of Transmitting Information<\/h1>\n

Comics really help to transmit information; thanks to them, readers can get the difficult idea quickly. I also recommend you to read the following blog post to learn about how comics can improve your documentation and brand loyalty:\u00a0Comics in Technical Writing<\/a>.<\/p>\n<\/div>\n<\/div>\n<\/section>\n

\n
\n
\n
\n

Ann Green, Content Manager at\u00a0ClickHelp.com \u2014 best online documentation tool for SaaS vendors<\/strong><\/a><\/p>\n

\n
\n
\n
\n
<\/div>\n

<\/div>\n<\/div>\n<\/div>\n<\/figure>\n<\/div>\n<\/div>\n<\/section>\n

<\/div>\n
<\/div>\n
\n
SOURCE: https:\/\/medium.com\/@ann.green\/comics-as-documentation-4f0e6882d4b9<\/strong><\/a><\/div>\n
<\/div>\n
Written by<\/div>\n
\n
\"Ann<\/a><\/div>\n
<\/div>\n
Ann Green<\/a><\/div>\n
\n
\n
Content Manager at ClickHelp. In my blog, I write about technical writing.<\/span><\/div>\n<\/div>\n<\/div>\n<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n","protected":false},"excerpt":{"rendered":"

Technical writing is not only about boring text. Some technical writers manage to create a user manual in the comics […]<\/p>\n","protected":false},"author":2,"featured_media":2627,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"default","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"categories":[12,128,47,21,40],"tags":[],"class_list":["post-2625","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-bloghassler-ec","category-clickhelp","category-medium","category-productividad","category-technical-writer"],"_links":{"self":[{"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/posts\/2625","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/comments?post=2625"}],"version-history":[{"count":1,"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/posts\/2625\/revisions"}],"predecessor-version":[{"id":2628,"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/posts\/2625\/revisions\/2628"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/media\/2627"}],"wp:attachment":[{"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/media?parent=2625"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/categories?post=2625"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/tags?post=2625"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}