Applying Web 2.0 Technologies to Technical Documentation

This article is based on my presentation at the Institute of Scientific and Technical Communicators' annual conference in October, 2006. Every now and then, there is a change in the value of what technical authors deliver. These are moments when organisations pay attention to technical documentation. This is because they recognise that these changes mean they can create something that will be of real value to the business and to their customers. In recent years, there have been three "waves of interestingness". The first wave was the introduction of Windows Help (WinHelp). The second major wave was the introduction of the Internet and intranets. This was a time when organisations looked at how they could transfer large amounts of information from paper to online. They were faced with issues such as how users could access and understand all this information easily - issues that technical communicators deal with on a day-to-day basis. I believe we're just about to approach the new wave, which we have called "Tech Writing 2.0".

Pratt, Ellis. Cherryleaf (2006). Articles>Web Design>Documentation>Technical Writing

Friend or Foe? Web 2.0 in Technical Communication  

The rise of Web 2.0 technology provides a platform for user-generated content. Publishing is no longer restricted to a few technical writers—any user can now contribute information. But the information coming from users tends to be highly specific, whereas technical documentation is comprehensive but less specific. The two types of information can coexist and improve the overall user experience. User-generated content also offers an opportunity for technical writers to participate as “curators”—by evaluating and organizing the information provided by end users.

O'Keefe, Sarah S. Scriptorium (2008). Articles>Web Design>Technical Writing>Social Networking

Is Your Website Poised to Deal With Its Growth?  

Every webmaster nourishes the dream that his or her website will make it the big way. This is very much human because people carry out any task in ardent hope. What is more human out here is that earthy fellows like us base our aspirations more on speculation rather than specific set of steps undertaken to bring the dream a bit closer to reality. And this is not all, particularly in case of growth of a site which brings newer problems in the wake of its growth. It cannot be disputed that you can probably get some good web hosting on economy price. But if you expect top of the line service on this price, acknowedge gracefully that your are just asking for the moon. Probably you are not catching up with wisdom that business needs decisive investments.

Azam, Rahbre. Amateur Writerz (2008). Articles>Documentation>Web Design>Technical Writing

Low Bandwidth and the Highs of Web Design

The emergence of Internet was, and still is a fascinating thing to happen in technology firmament. The ease and the comforts of connecting to people, defying geographical boundaries, and getting a global audience for businesses were unparalleled -- first of its kind ever. So wonderful a thing has, unfortunately, got its share of woes -- the connection speed. The bandwidth of Internet connectivity was considerable at the time when it was entirely new to the world. The newness of the medium did not let it know to the excited lots of users and beneficiaries. Gradually, when people wished for more speed, they earnestly expected that things will turn favorable in the times ahead. Strategy is not something entirely applicable to chart out the direction of a corporation. Yeah, Your web design has to be strategized as well if you wish to serve your target audience in business friendly manner.

Azam, Rahbre. Amateur Writerz (2008). Articles>Web Design>Technical Writing>User Centered Design

Quality Criteria for Indexes, Website Navigation and Search    

When users find the answers they are looking for, the investment in technical documentation gets a chance to pay off. In large volumes of technical information, just finding the answer can be half the battle. Microsoft found that users of its intranet were spending an average of 2.5 hours per day online - 50% of that being searching. This article was written as part of an experimental online workshop with the MITWA (Mentors, Indexers, Technical Writers & Associates) discussion group(http://groups.yahoo.com/group/MITWA/). The article retains the workshop format including learning assignments.

Brown, Fred. International Journal for Technical Communication (2006). Articles>Information Design>Web Design>Technical Writing

Teaching Web Design in the Technical Writing Service Course: Steps Toward a Planned Evolution  

This study uses an online survey of technical communication educators to examine trends in the technical writing service course with regard to web design. Participants for the study were representatives of programs in technical communication in four-year institutions of higher education throughout the United States. The study contributes to research into the function of the technical writing service course in the current technological climate. Identifying trends is one component in an evaluation that will aid effective evolution of this significant course.

Brewer, Pam Estes. STC Proceedings (2004). Articles>Education>Web Design>Technical Writing

Web Content Writing Is Not Technical Writing

We’re all taught that online writing has to be hard hitting and quick because readers scan, and will not invest time in reading a meandering piece. My brain so efficiently crunches data and spits it out in list format, complete with headings and summarized with concise sentence structure, that I have a hard time writing anything else.

Designing User Experience (2008). Articles>Web Design>Writing>Technical Writing

What is Web 2.0 and How Will Technical Writers be Impacted?

Understanding the potential implications of a paradigm shift in how we view writing for the web. For content to reach the types of syndication and distribution imagined by web 2.0 enthusists, content needs to break free of the containers that both bind it and display it. One of the most significant ways that this transition to Web 2.0 can be seen is in the move toward XML, and semantic markup. With this move toward the granulation of content however technical writers need to rethink how to present content.

Diehl, Amy. Content Matters (2006). Articles>Web Design>Writing>Technical Writing

Seven Top Web Writing Principles For Technical Writers

Web writing is one of those assignments that technical writers do well due to their organized approach to technical information. But web writing differs from regular user guide and procedural writing in some important respects. The Web is a fast place. People usually don’t have the time to go through long essays.

Technical Communication Center (2009). Articles>Web Design>Writing>Technical Writing

Designing Websites

The parallels between the theories of technical communications and those of web design are very similar, the key aim is to keep the audience in mind at all times. The way you structure and present the information is also important, as is a sense of usability of the content itself.

McLean, Gordon. One Man Writes (2009). Articles>Web Design>Technical Writing>User Centered Design

Think Mobile When You Write

Always keep the small screen in mind when you’re preparing your docs. There are some W3C “mobileOK” guidelines to consider to ensure that your content meets requirements. Here are some highlights.

Norris, Julie. 2moro Docs (2009). Articles>Web Design>Wireless Web>Technical Writing

Twenty-Five Clear And Beautiful Comparison Tables

There's no point in having an awesome website and an awesome product if your product comparison table is crap. It will throw people right off, and believe me I have seen some bad tables. Anyway here is a collection of the best product comparison tables handpicked by WebdesignDev. We think we have picked the top 25 comparison tables based on creative design and how clear it is to read and compare.

Johnson, Andy. Web Design Tutorials (2009). Articles>Web Design>Technical Writing