I'm a technical writer based in the San Francisco Bay area of California. 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...

Contextual Navigation One of the most hotly debated topics in tech comm deals with how writers should cross reference other topics within a help topic. Some writers feel that including contextual or inline links in your help topics distracts low-literacy readers by encouraging them to...

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...

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...

I'm a technical writer based in the California San Francisco Bay area. 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...

The problem is that some image types are meaningless when the text is removed. Think of graphs without labelled axes, or, even worse, flowcharts with just numbers in all the boxes. My previous post (11 images issues for tech doc systems) explored some of the challenges inherent in...

of the issues that images present 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...

. 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...

have an Agile documentation team with its own sprints, whose members work in tight collaboration with the Agile development teams... (Product vs. User Perspective in Agile Documentation) Mark Baker also seems to recommend a similar approach: This is why I always advise tech comm groups...

 

Related shopping