Tag: Development

Yes, writers and developers can coexist

I'll admit that the impetus for this article is that I'm thinking about new presentation ideas. This is one of the ideas that I'm tossing around. In conversations with other technical writers, one common thread that I've come across is the inability of technical writers to work with technologists, such as developers, DBAs, and so … Continue reading Yes, writers and developers can coexist

An introduction to the C4 model

(Image source: The C4 Model for Software Architecture) This week, I was introduced to a new (to me) methodology called the C4 model. Now, in this context, C4 does not refer to the high explosive. In this case, C4 refers to a development methodology. Mostly, it refers to software development, but it has other applications … Continue reading An introduction to the C4 model

Fixing the worst online job application

Earlier, I wrote about what may be one of the worst online job applications I've ever experienced (I'd suggest reading that article first; otherwise, this one might not make sense). It got me thinking: what if I had an opportunity to fix this horror show of an experience? Here's what I would do. My first … Continue reading Fixing the worst online job application

Albany Code Camp — April 25 @AlbanyCodeCamp #albcc

I received an email over the weekend about a new event for this year -- and for once, it isn't related to PASS or SQL Saturday. On Saturday April 25, the first (hopefully, annual) Albany Code Camp will be held! I submitted four of my presentations. We'll see if any of them are selected. Stay … Continue reading Albany Code Camp — April 25 @AlbanyCodeCamp #albcc

Consistent code infrastructure

"Any fool can write code that a computer can understand. Good programmers write code that humans can understand."-- Martin Fowler I'm currently working on a project in which I'm trying to deconstruct a database. In doing so, I've come across a number of things about it that, in the scope of databases, appall me. Who … Continue reading Consistent code infrastructure

Stop treating technical writing like a second-class citizen

File this under another technical writing frustration. Imagine that you are an application developer. You finish an app for a client that you send for review. The app is clearly labeled as a "testing version," and includes source code (yes, I know this last part doesn't happen, but just humor me for a bit). You … Continue reading Stop treating technical writing like a second-class citizen

First drafts are ugly

"The secret to life is editing. Write that down. Okay, now cross it out."William Safire, 1990 Syracuse University commencement speech "No thinking - that comes later. You must write your first draft with your heart. You rewrite with your head. The first key to writing is… to write, not to think!"William Forrester (Sean Connery), Finding … Continue reading First drafts are ugly

For every action, you need a reaction

I came across yet another example of bad interface design this morning. After I logged into my computer, a pop-up window appeared. It was my Docker application, telling me that an update was available and ready to install. Okay, I said to myself, and clicked the button to proceed. Except... nothing happened. I clicked it … Continue reading For every action, you need a reaction

Playing in the sandbox is important for documentation

While working on a user guide, I realized that I had administrative rights to the application I was trying to document. That was all well and good, except that I was trying to write a non-admin user guide, and I needed to know how someone who didn't have admin rights saw the application. Fortunately, one … Continue reading Playing in the sandbox is important for documentation

Testing something? What’s the test plan?

Imagine if you will that you've been asked to test a product. The product could be anything -- software, a car, a kitchen appliance, a piece of sports equipment, whatever. For the purposes of this article, we'll say you're working at some company, and you've been asked to test a piece of software. You're told … Continue reading Testing something? What’s the test plan?