#28228
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
#20287
Building the Treasure House: Creating Knowledge Bases on the World-Wide Web 
Web knowledge bases offer an excellent platform for delivering technical documentation and customer support information. They also represent an area of great opportunity for technical communicators to expand their skills, satisfy their customers, and create value for their employers or clients. This session explores the components of a web knowledge base and the tasks involved in planning and building one.
Massa, Jack A. STC Proceedings (1998). Articles>Documentation>Online>Web Design
#27658
Constructing a One-Stop "Answer Station" Website for Software Users
The web allows us to easily provide updated documentation to our users, but why stop there? There is more to making users successful quickly than just providing documentation. By creating a complete 'Answer Station' that is accessible from the application or product, we can not only direct users to that updated documentation, but we can also provide information about technical support, consulting, training, sales, etc. This article discusses writing a proposal for an Answer Station, determining content, working with other departments to gather information, designing the site, making that design work with an existing corporate website, dealing with tool issues, and finally, going live.
Bleiel, Nicoletta A. and Beth A. Williams. WritersUA (2004). Articles>Documentation>Web Design>Help
#23264
Hypertext for Handling Conceptual Material
Turning 'help' systems and 'browsers' into robust structured-document viewers: the DocBrowser.
Hoffman, Michael. Hypertext Navigation. Articles>Documentation>Web Design>Web Browsers
#30766
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
#20551
Restructuring Online Documentation for the World Wide Web
Technical communicators around the world are turning to the World Wide Web us their primary delivery agent for on-line documentation. The transition from older forms of on-line documentation to HTML-based documents pre - sents new challenges in every phase of the documentation process: document creation, layout, access, and especially hypermedia capability The constant development of new web tools presents an even greater challenge for an organization seeking to stay abreast of technology with an ever decreasing budget. This panel will outline the basic steps in migrating to the web while focusing on one organization’s solution to meeting the challenges of restructuring its on-line documentation for web migration.
Goode, Christina M., Jennifer Campbell and David Hale. STC Proceedings (1996). Articles>Documentation>Web Design>Online
#25619
Six Tips for Improving Your Design Documentation
Good organization, complete information, and clear writing are, of course, key to the success of any design document, but there are some other, less-obvious techniques you can use to make your documents more readable and understandable. Here are a few of them.
Olshavsky, Ryan. Boxes and Arrows (2003). Articles>Web Design>Documentation
#31740
Systems That Get Better the More People Use Them
In Publishing 2.0, Tim O'Reilly says Web 2.0 is 'any network effect that makes a system better the more people use it.' Web 2.0 isn’t just user-generated content; it’s harnessing the collective intelligence of your users to make your system better.
Johnson, Tom H. I'd Rather Be Writing (2008). Articles>Documentation>Web Design>Social Networking
#31974
Several years ago, someone used the term WYSIOP (What You See Is One Possibility) when talking about the RoboHelp HTML editor, because what developers saw in the editor didn't usually match the results. I had what I thought was an absolutely brilliant leap of logic ;-) a couple of months ago when I realized that today's WYSIWYG (What You See Is What You Get) editors are really WYSIOP, because the results are determined by whatever layout template is assigned at the time the results are viewed.
James-Tanny, Char. Helpstuff (2006). Articles>Web Design>Document Design>Adobe RoboHelp
#32395
Blockquotes do have some styling by default. Most browsers will indent the text in a blockquote tag, which helps the user recognize that the text is different somehow. But who’s to say that we need to stop there? Here are six different ways you could style your blockquotes using CSS.
Glazebrook, Rob L. CSSnewbie (2008). Articles>Web Design>Document Design>CSS
#32405
Book-Style Chapter Introductions Using Pure CSS
Today’s tutorial will show you how easy it is to create book-style chapter (article, whatever) introductions using nothing but pure CSS — no XHTML was harmed in the making of this tutorial. We’ll use two types of selectors which I haven’t talked about yet here: adjacent sibling selectors and pseudo-element selectors. I’ll explain each type briefly before we get started.
Glazebrook, Rob L. CSSnewbie (2008). Articles>Web Design>Document Design>CSS
#32434
Every web designer should know and understand a Web site’s parameters before lifting a finger to start designing the site. In this article, you will learn the basics required to start designing business Web sites. While this information is useful if you want to build sites for others, it can also serve as a checklist article for sites you want to build for yourself.
Goin, Linda. Opera (2008). Articles>Web Design>Document Design>Information Design
#32504
How to Prevent HTML Tables from Becoming Too Wide
The layout model of tables differ from that of block level elements in that they will normally expand beyond their specified width to make their contents fit. At first that may sound like a good thing – and it often is – but it makes it possible for oversized content to make text unreadable or completely break a site’s layout, especially in Internet Explorer.
Johansson, Roger. 456 Berea Street (2007). Articles>Web Design>Document Design>HTML
#33145
Five Simple Steps to Designing Grid Systems: Grid Systems for Web Design, Part 1
Designing grid systems for print is considerably more straight forward than designing grid systems for the web. First off,in print, the designer has a fixed media size - the paper size (or packaging, poster, whatever). Let's say a print designer has designed a magazine. The reader of this magazine can't suddenly increase the font size if they find it difficult to read - well they just move it closer to their eyes I guess. This is just one consideration, there are more but I'm sure you get the point.
Boulton, Mark. Mark Boulton (2007). Articles>Web Design>Document Design>Methods
#33146
Five Simple Steps to Designing Grid Systems: Grid Systems for Web Design, Part 2
Fixed width grid design for the web. What is it, how do we do it and how do we implement it? For the purposes of this article, I'm going to be focussing on the theory of creating the grid rather than the implementation. I did mention in the last series that I would cover implementation using CSS, well I'm not going to. There are just so many resources and books available telling you how to create the CSS layouts you need—I'll touch on it, but I won't be going into too much detail.
Boulton, Mark. Mark Boulton (2007). Articles>Web Design>Document Design>Methods
#33147
Five Simple Steps to Designing Grid Systems: Grid Systems for Web Design, Part 3
Flexible vs Fixed. Which one to choose? Why choose one over the other? Well you won't find the answers to those questions here. What I'm aiming to do with this article is to investigate how the theory of grid design can be applied to a flexible web page.
Boulton, Mark. Mark Boulton (2007). Articles>Web Design>Document Design>Methods
#33227
Using a “Strawman” for Page Layout Design
Designing the page layouts for a new or redesigned intranet can be complex. One of the most difficult aspects is creating the first layout. Starting with an empty screen, you need to determine what will go on each page and where it will go. Using a strawman design - a design that is created with the intent of discarding it - can help to overcome many of the difficulties in the design process.
Spencer, Donna. Step Two (2004). Articles>Web Design>Document Design
#33228
Visible Narratives: Understanding Visual Organization
Visual communication can be thought of as two intertwined parts: personality, or look and feel, and visual organization. The personality of a presentation is what provides the emotional impact —your instinctual response to what you see. Creating an appropriate personality requires the use of colors, type treatments, images, shapes, patterns, and more, to “say” the right thing to your audience. This article, however, focuses on the other side of the visual communication coin: visual organization.
Wroblewski, Luke. Boxes and Arrows (2003). Articles>Web Design>Document Design>Visual Rhetoric
#33233
It appears that about one out of five Web sites (only 20%) currently are designed using a "Fluid" layout. Unfortunately, the layout most preferred by users, the "Fluid" layout, is the one implemented least often by designers.
Bailey, Robert. Human Factors International (2001). Articles>Web Design>Document Design
#33694
Reviewing Wiki Documentation via Crucible
I have been playing around with Crucible, Atlassian’s peer code review tool. The latest version of Crucible allows you to review Confluence wiki pages. This is a new feature, so I decided to try it out. Also, I was wondering why you might want to use an independent tool to review a wiki page, when you could instead just add comments to the page or update the page directly.
Maddox, Sarah. ffeathers (2009). Articles>Web Design>Documentation>Wikis
#33941
Fluid layouts are an undervalued commodity in web design. They put control of our designs firmly in the hands of our users and their browsing habits. They’ve also utterly failed to seize the imagination of web designers.
Marcotte, Ethan. List Apart, A (2009). Articles>Web Design>Document Design>CSS
#33964
Positioning is perhaps one of the most misunderstood parts of CSS 2. Let us look a little closer at how it works.
Olsson, Tommy. Autistic Cuckoo, The (2004). Articles>Web Design>Document Design>CSS
#33965
Pozycjonowanie z kolei jest jednym z najczęściej mylnie interpretowanych aspektów wersji 2 CSS. Przyjrzyjmy się zatem nieco bliżej temu, jak ono działa.
Olsson, Tommy. Grabun.com (2004). (Polish) Articles>Web Design>Document Design>CSS
#33966
Hizalama ise CSS 2’nin belki de en yanlış anlaşılmış bölümlerinden biridir. Şimdi nasıl çalıştıklarına biraz daha yakından bakalım.
Olsson, Tommy. Cnkt (2004). (Turkish) Articles>Web Design>Document Design>CSS
#33967
This article explains one method of achieving a successful liquid layout as well as providing basic definitions of liquid, fixed-width and em-driven layouts.
Weakley, Russ. MaxDesign (2003). Articles>Web Design>Document Design>CSS
