Thankfully there are a multitude of tools and approaches to help you overcome these challenges and in this post I summarise some (there are lots of quite similar tools) of the options available to you, and how they help you with the following:Īny other useful features for documentariansįor each example, I include a small summary, costs, operating system (OS) support, and any standout features. Not all readers of documentation see images, and it’s essential to provide alternative text to describe them, which is another task to remember to undertake and keep up to date and relevant. One other aspect to consider is accessibility and automated services. Many people now use high resolution or large screens, and small low resolution images generally appear pixelated and unclear if you capture them on a small or lower resolution screen. The same applies for taking clear screenshots.
It’s relatively easy to take a screenshot, but taking a screenshot that actually supports and supplements text is an art in itself. This is time consuming, hard to manage and to remember.Īnother challenge is capturing a helpful and useful image. The biggest challenge with screenshots is keeping them up to date and thus relevant to readers. Images help break up page structure and draw a readers eyes to text as they scroll through a page and the images draw their attention. Well considered images in documentation can help illustrate a concept, clarify a complex idea, or show a reader what they can expect from undertaking certain steps. I won’t repeat any famous phrases about how pictures equalling a quantity of words, I think we all understand the potential power of a good visual. In the future they will be optional.Tools to help generate screenshots for your documentation In the subshare file edit the following variables in accordance to your parameters. As I couldn't find a suitable option for linux I decided to create my own and wanted to share for whoever else thought useful. Nextcloud for file uploads, Hastebin for sharing code/text files, Polr for shortening links and Scrot for capturing screenshots. My workflow for sharing files, images, link and text consists of a few self hosted services. This project began when I couldnt find a suitable linux alternative for ShareX, which I used on windows to capture my screenshots, upload to my Nextcloud and copy a shareable link where I could post onto my blog, Discord and have access to anywhere when away from my computer via Nextcloud.
0 kommentar(er)
