Technical writing examples

I wrote, rewrote, or extensively edited all of this documentation, as of mid-2024. Note that while RethinkDB documentation has mostly remained static, Bixby documentation may change in the future, depending on how much effort Samsung continues to put into it. (I plan to update this page with PDFs or static web captures soon.)

These are just representative samples. I wrote or edited most of RethinkDB’s documentation, as I was the sole tech writer at the company; I was part of a three-person team at Samsung, and wrote a substantial portion of Bixby’s, particularly with respect to APIs and the proprietary development environment.

Developer Guides

• Changefeeds in RethinkDB: A higher-level guide to “changefeeds,” RethinkDB’s streaming data API.
• The Bixby Modeling Language: An overview of the declarative modeling language used by Samsung’s Bixby voice assistant.
• Bixby Developer Studio: Documentation for the Electron-based code editor used for developing Bixby applications.

API documentation

• RethinkDB Changefeed API: The API for changefeeds. Note that I wrote the documentation for all four supported languages here, and wrote nearly all the Java examples.
• Bixby API Reference: Reference material on Bixby’s library capsules, JavaScript API, and Assertions (for testing).

Other work

• Bixby Modeling: A post written for Bixby’s developer relations blog (no longer online). It’s more of a high-level overview of the Bixby application environment and written in a conversational style, although it’s still aimed at developers. (PDF)
• BBEdit 14, and why you should care: A review of BBEdit 14, the first version of the venerable macOS text editor to get support for the Language Server Protocol.
• Review: Nisus Writer Express 2.0: A review of Nisus Writer Express, a relatively early Mac OS X word processor, written for online magazine “About This Particular Macintosh”.