The relationship between technical writing and application UI

During a recent work meeting, we were discussing an online Wiki-like internal document that I’d written. There was mention of a line that needed to be included. I mentioned that I’d need to figure out how to word it, and where it should go — pretty typical work when editing any technical document.

For some reason, during that conversation, I started thinking about how locating that — and other pieces within the document — affected its readability. That thought made me think about interfaces — how certain UI/UX pieces on an application can influence how an end user views and uses it.

That’s when it occurred to me: there is a direct correlation between technical writing and UI design.

It should be an obvious idea, but for me, it was a revelation. There isn’t a lot of difference between how a document is laid out and how a user interface is arranged. Many design principles between them are the same. The user’s eye path follows the design. How he or she reads the document or uses the application is affected by how the document is laid out or how the UI is designed.

I’ve written before about how design is important. I’ve also written about documentation issues (time and again). Like everything else, technical writing and UI design is a skill. A good technical document and a good user interface both require planning — as it turns out, the same kind of planning — to execute properly.

Advertisements

Learn More than Technology

Nice article by my friend, Steve Jones.

Voice of the DBA

I’ve been lucky and successful in life in many ways. Certainly I’ve worked hard, may long days and nights, but plenty of others have as well. In fact, there are plenty of people I know that have worked more hours, but been less successful. Conversely, I know some that have worked much less and been more successful. It’s hard to know what the best way is for each of us to examine how to move forward in life, but it’s also not really helpful to compare yourself with others as a measurement. What I’d note you should do is decide if you think you’re becoming more or less successful and find your own path.

This could mean very different things to different people, and that’s fine. I don’t want to live other people’s lives. I want to live my own, learning from positive and negative things that happen to others…

View original post 392 more words

Upcoming speaking engagements (as of 2/5/19)

Things are getting busy. My SQL Saturday presentation efforts are paying off. It seems like I have a lot of stuff coming up! So for those of you who are having trouble keeping my schedule straight (like I am), here’s what I have so far.

I’ve also applied to speak at the following events. I don’t yet know whether or not I’ll be speaking at any of these, but we’ll see what happens.

There are some other events for which presentation applications are not yet live, but once they are, I intend to submit to them. They include:

  • October 5: SQL Saturday Pittsburgh
  • November 5-8: I intend to apply to speak at PASS Summit, Seattle! PASS Summit has been described as “the Super Bowl of SQL Saturdays,” so getting picked to speak here would be a big deal. We’ll see what happens!

So that’s how my schedule is shaping up so far! Of course, as the year progresses, this schedule is subject to change.

I’ll see you somewhere on the road!

Monthly CASSUG meeting — February 2019

Greetings, data enthusiasts!

This is a reminder that our February CASSUG meeting will take place on Monday, February 11, 5:30 pm, in the Datto (formerly Autotask) cafeteria!

Our guest speaker is Rie Irish! Her talk is entitled: “Well, actually… How to not be THAT guy in IT”

For more information, and to RSVP, go to our Meetup link at http://meetu.ps/e/FWkQ4/7fcp0/f

Hope to see you there!

My first virtual presentation! March 8

I will be giving my first virtual presentation on March 8!

At 2:00 pm (US Eastern time), I will do my presentation: “Networking 101: Building professional relationships!”

That means YOU can attend! You don’t have to go to a SQL Saturday or a user group meeting! Go to the above link and register!

Hope to “see” you there!