REST API Doc article

I think the big problem with API docs is what to document. And it usually ends up with a comment per method, where you have “createFoo = creates a foo; deleteFoo = deletes a foo” and no real content. The question always becomes “well, what else?” And the real value of API docs is everything […]

The hoarding of 25,000 manuals

I started tech writing right around the time print was dying. My first job involved writing software documentation as a manual and as WinHelp, and it all went electronic after that. I also briefly wrote for print books about Linux and Emacs. So I have a box with versions of those manuals, and that box […]

Removing the Adobe Update Installer from the Mac menu bar

So at some point, Adobe Creative Cloud added a second notification to the menu bar on my Mac. There’s already one that opens the CC app, and always sits in the menu bar. And everyone else wants something in the menu bar. But Adobe started showing this second icon, with a perpetual 1 next to […]

Making Yosemite Readable

I resisted the upgrade to Yosemite, even though I have a pretty new mid-2014 MacBook Pro, because I’d rather let someone else beta-test things before I upgrade. When I finally did upgrade, I noticed a problem: my eyes were killing me.  Granted, I’ve put a few hundred thousand miles on my eyeballs over the last […]

Photoshop CC Keyboard Shortcut Cheat Sheet

It seems like the days of cardboard key templates are over – they were a huge thing back in the old days when I started as a consultant in the computer labs back in college. Most of the cool kids would memorize everything, but more of the “returning” students would overlay the laminated cut-outs over […]

Blank Markers in FrameMaker

Here’s a FrameMaker problem I had once on a 64-bit Windows machine. I don’t remember having it on my next Win7 machine, but I’ve seen it more than once. The problem: the marker symbols were missing. These are the little “T” symbols you normally see when you insert a cross-reference or an index marker. The […]

Read the Docs

Here’s something neat I found recently, while looking for some api docs. It’s been around for a while, but you might not have seen it if you don’t work with Python much. Check this out: https://readthedocs.org It’s a documentation repository, and you can find docs for a lot of Python projects there, in one searchable place. And […]

The FrameMaker Text Inset Header Problem

Here’s a FrameMaker thing that burns me once a year, usually a few hours before a release. So, you’ve done this: Created a text inset file that begins with a Head1 paragraph style. Inserted that file as a reference in another file, at a point where the paragraph style was Body. Did a book update, […]

The Hello, World Post

Hi and welcome to my page. This is mostly a “blog about this insane little problem so I’ll remember it in a year,” but maybe some of these factoids will be useful to you, too. Click on any of the above to learn more about me. Or keep scrolling to see my current blog posts. […]