Search results

Design good websites by following principles of technical writing style

by Tom Johnson on Mar 1, 2007
categories: technical-writing

Designing good websites involves following the same principles of technical writing — be invisible in style. In this Edgework podcast, Joshua Porter explains that good web design isamazon good web design often invisible. Users shouldn't be concentrating on the design. Like Amazon, you focus on the content. You focus on the fact that it works.

I strive for the same in my technical writing. I want the user to focus on the content, not my literary style. I remember reading Armies of the Night by Norman Mailer and being awestruck by the literary flow. But while I was impressed, I preferred books that gripped me with the story rather than the style.

Technical writing doesn't call attention to itself for its style. Its style is invisible. Its purpose is to teach the user how to do something. You don't read to be impressed by literary acrobatics.

I hadn't thought how the same invisibility principle might apply to good web design. But it does. Sure you want to make a good impression, and graphic design counts. But the most popular websites are popular because they simply work. Google, Craigslist, Flickr, Digg, Amazon — you don't dwell on the visual design of these sites.

Often the simpler a site, the better. Porter even quotes Alexander Pope about how "he did not have time to make his letter shorter." In other words, shorter, simpler, invisible design is often harder than long, complicated, flashy designs.

About Tom Johnson

Tom Johnson

I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.

If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.