|
Last month, I introduced you to Dan Sanderson, the technical writer at the revived Commodore. This month, we conclude our interview by discussing the documentation process, what Commodore wants users to experience, and advice to beginning technical writers.
What software and hardware did you use to create the documentation?
I insist on LaTeX when given a choice. It’s old and arcane, but also powerful enough for the most demanding book designs. Everything is in text files that can be edited with text-oriented tools, stored in revision control systems, and constructed with scripts and macros. WYSIWYG tools just don’t give you enough control to produce a quality result, and are not amenable to workflow automation beyond simple tasks. Even the industry standard commercial typesetting software is buggy and under-supported. If you’re patient enough to learn it, LaTeX overcomes all of those problems.
The worst part of LaTeX is error handling. With great power comes great ability to mess up a whole book with a small change. You get used to it.
I have several projects where I’m using LaTeX to mimic the typesetting of vintage computer books from the 1980’s. It’s been fun to notice how easy it is to do this in LaTeX, partly because LaTeX was likely used to typeset those books in the first place.
What is your documentation process? How do you go from specs to first draft to SME and QA reviews to production?
I’m too much of a software engineer to write prose based on specifications alone. I know that’s how it works at some companies just to give the writers some lead time, but final products are so different from their specs in many cases. If I’m documenting your software, I’d rather read your code, build the program, and keep my hands on the actual product for as long as possible. That’s the best way to learn what the user’s experience will be like, and what questions the user will have at every turn.
We had a chance to beta test the Commodore 64 Ultimate User’s Guide with a group of people, and I really appreciated their feedback. The material we used from the original User’s Guide has been time tested and that saves us on QA time, but we still found errors even in the vintage text that we were able to fix.
Is the user guide translated? If so, how do you work with localization teams? What languages do you produce?
As of this writing, the Commodore 64 Ultimate User’s Guide is only in English, with the safety and regulatory text translated to multiple languages. Commodore’s legal and safety people managed most of that process, I just did the typesetting. I did have to learn a bit about non-English alphabets to make sure the typesetting was accurate. |