Lauren Jenkinson transforms her lips into cartoon characters. Didn't see that one coming did you? Well, not if you haven't already seen the accompanying pictures at least. Yes, this makeup artist has created everyone from Shrek to Minions on her lips, which are surely soon to be famous....

Topics I write about on this blog include technical writing, authoring and publishing tools, API documentation, tech comm trends, visual communication, technical writing career advice, information architecture and findability, developer documentation, and more. If you're a professional or...

Good documentation is hard to write for a number of reasons -- operating systems, versions, technical abilities, and business scenarios often differ between tech writers and users. Products often evolve after the doc was written, since tech writers aren't always integrated with the team...

Madcap Central, recently released in early January, is a new cloud-based collaboration and publishing solution for tech docs from Madcap Software. Madcap Central allows you to configure and deploy Flare builds from a central server. You can also manage tasks, teams, users, and other details...

How many of you create CUSTOMER-FACING content using Markdown? (Markdown for creating technical content? (versus DITA)) The debate about whether to treat Markdown as a first-class citizen in tech comm authoring workflows is a debate that cycles periodically, but this time the author seems...

My previous post (11 images issues for tech doc systems) explored some of the challenges inherent in handling images in technical documentation. Unless you're writing very image-intense documentation, you're probably using a system that does not include all the image information. For...

with tech docs. For example, sorting out references to the images, single sourcing re-used images, converting SVG image formats to ensure browser compatibility, and ensuring the right file size for optimal page loading are some of the challenges that tech writers face when working with images...

. In this presentation, I introduce the tech comm conference attendees to Jekyll and how it can be used for authoring technical documentation. I'll try to demo a few of the tasks I describe. My slides are linked below (format is RevealJS): Here's the description of my Jekyll...

Writing tech docs like a hacker with Jekyll Static site generators are a new breed of documentation tools that are much more common in engineering groups where developers contribute to the documentation. Jekyll is one of the most popular static site generators, but it is highly similar to...

In my next post, I'll briefly discuss some alternatives to integrating into engineering Scrum teams. Get new posts delivered straight to your inbox. I'm a technical writer based in the California San Francisco Bay area. Topics I write about on this blog include technical writing,...

 

Related shopping