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. 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.
Docs as code is an increasingly popular approach for tech writers that follows similar principles for writing that developers follow for writing code. Docs as code typically means writing in markup languages such as markdown, asciidoc, or restructured text. The tools for writing in these markup languages are different from the specialized technical writing tools you might have used before, and again, are often designed for coding or general writing. This post looks at some of the best you can try if considering a switch to docs as code.
Welcome to a new newsletter/post/radar/term-yet-to-be-defined from me that I have been planning for ages. I intend it to be something of a round up of tools and services i’ve been trying recently, plus also industry analysis and trends. To begin with it’s just the tools and service round up as the analysis part requires more thought that I haven’t had time for yet.