The following is a guest post by Jeanine Shepstone. In this post, Jeanine talks about some 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 writers face when working with images in tech docs.
During the May WTD meetup, Ruthie Bendor, a web engineer, gave a presentation titled Move Fast And ... Document Things? Lessons learned in building documentation culture at a startup. This post contains the audio and video recording of her presentation.
We recently hosted a Write the Docs meetup in Redwood City with a couple of excellent presenters. A recording of Ruthie Bendor's presentation is below.
We recently hosted a Write the Docs meetup in Redwood City with a couple of excellent presenters. Below is the recording of Neal Kaplan's presentation. I also explain a bit about my new lapel mic and recording process.
I attended the 2016 STC Summit in Anaheim, California this year. This is a brief, rambling post that recaps some of my thoughts and experiences.
Here are the slides for my STC Summit 2016 talk on Writing Tech Docs Like a Hacker with Jekyll presentation. 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.
I'm trying to come up with way of providing more context for users in documentation. Providing context is essential to helping users understand how all the various pieces fit together. Without context, the information becomes fragmented and seems unorganized, maybe even random. I've tried a couple of approaches to establishing context -- consolidating the information more while I draft it, and also putting maps with signposts throughout the content. I still have a ways to go to figure this out.
Capture and display at a 1:1 ratio Zoom out on your browser’s magnification Capture from a Retina display Examples of Retina versus non-Retina screen captures Summary Technical writers take a lot of screen captures, often showing interfaces with both text and graphic elements. Usually these are partial screen captures that focus on the part of the screen they are highlighting. (By “screen capture,” I’m referring to captures taken ...
My slides and video for Jekyll Conf 2016 are available below. In this presentation, I talk about the various challenges I've had in using Jekyll for technical documentation. I explain my attempts to overcome requirements with everything from conditional filtering to generating PDFs, publishing across different environments, re-using content across projects, templatizing notes and alerts, and more.
I recently gave a lightning talk at a Write the Docs meetup in downtown San Francisco. My talk was titled Creating professional graphics in the easiest, simplest way possible. This post contains the slides, recordings, and other notes.
In this series on visual communication, I'm going to explore in a variety of topics in visual communication, such as screenshots, diagrams, concept illustrations, SVG graphics, translation, image file management, graphics programs, getting professional-looking images, images on mobile displays, print versus online images, design principles, and more.
Today I was thinking about the most important element in a successful technical writing career, and I think it's knowledge. The more you know, the better information you can write. There are at least three main types of knowledge: product knowledge, technical knowledge, and user knowledge. Just knowing one of the three won't provide you with the kind of information you need to write good documentation.
Alicia Avrach, a content strategist at ThoughtSpot, gave a presentation about video documentation at a recent Write the Docs San Francisco meetup. In this presentation, Alicia covers all the aspects of video production, from scripting to recording, post-processing, publishing, and more.
Sanborn Hodgkins gave a presentation to the STC Silicon Valley chapter called Shape of a Modern Technical Communication Organization on April 18. In the presentation, she highlights the variety of roles -- editor, videographer, information architect, content strategist, manager, writer, tools developer, and others -- that tech comm organizations need to thrive.
About Tom Johnson
I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.
If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.
© 2023 Tom Johnson