Documenting Networks

Documenting networks is playing less with words, and more with diagrams. It also requires an engineering mind, an ability to think out-of-box, and creative mind. Technical writers can rise to a new scale and expand their skill sets if they are able to document networks.

EDITsphere (2007). Articles>Documentation>Intranets>Graphic Design

Electronic Catalogs: Graphics    

A compilation of the most frequently asked questions about graphics in electronic catalogs. You will find answers to general as well as to technical questions.

ITEDO Software (2003). Design>Documentation>Graphic Design>Online

Empirical Proof for Presenting Screen Captures in Software Documentation    

None of the previous studies on screen captures addressed the functions in the framework. There was no empirical research on any of the four functions of screen captures. This article presents our research on these functions. Each section starts with a brief explanation of the function. Next, we illustrate the screen capture designs used to test the function. The remainder of each section explains the setup and results of the empirical study. The article ends with some general conclusions about the functions of screen captures.

Gellevij, Mark and Hans Van Der Meij. Technical Communication Online (2004). Articles>Documentation>Graphic Design>Screen Captures

Managing Quality Graphic Design in a Documentation Project  

Supervising the design of documentation is challenging for documentation managers who have little or no educated knowledge of design. However, quality design that maintains ease of reading, accessibility, comprehension, retention, and aesthetics is vital to the usability and success of the documentation and should be carefully monitored by the documentation manager. Decisions must be made up front on four design areas -- packaging, layout, typography, and highlighting -- before the project is underway. In addition, audience analysis and a design style guide are two techniques that managers should embrace in supervising design.

Listeman, Amy J. STC Proceedings (1995). Careers>Graphic Design>Document Design>Documentation

Putting Graphics Online: Avoiding the Pitfalls  

Online information is becoming more the norm today than paper-based materials with online Help a standard with most products and the proliferation of the Internet and intranets. However, putting graphics online can be one of your biggest headaches in an online project. This paper will introduce some of the issues you will encounter when putting graphic information online and make suggestions on how to solve them.

Cooper, Charles and Ann Rockley. STC Proceedings (1997). Design>Graphic Design>Documentation

Screen Captures to Support Switching Attention      

This study set out to validate the supportive role of screen captures for switching attention. Forty-two participants learned how to work with Microsoft Excel with a paper manual. There were three types of manuals: a textual manual, a visual manual with full-screen captures, and a visual manual with a mixture of partial- and full-screen captures. The findings show that participants in all conditions looked up from the manual to the screen on about 97% of the cases in which such a switch was called for. Rank order analyses showed that users of the visual manuals switched attention significantly more often than did users of the textual manual. No differences were found between conditions on learning effects and training time.

Gellevij, Mark and Hans Van Der Meij. IEEE Transactions on Professional Communication (2002). Design>Graphic Design>Documentation>Screen Captures

Screenshots with the Mouse Pointer

How to produce screenshots which include the mouse-pointer.

Springer, Hans. TC-FORUM (1999). Articles>Graphic Design>Documentation>Screen Captures

Taking a Second Look at Screen Captures  

Asserts that screen captures aren't as necessary and helpful as many writers of documentation might think.

Bright, Kathy. Intercom (2001). Design>Documentation>Graphic Design>Screen Captures

Using Graphics to Help Users Build Mental Models  

Research shows that adults learn more efficiently when they have formed an accurate mental model of the product they are trying to use. We can help our users form accurate mental models more quickly by graphically depicting that model on the interface. One product using that approach allowed engineers to become productive with no reference to user documentation.

Elser, Arthur G. STC Proceedings (1995). Articles>Documentation>Graphic Design

So, You Want To Screen Capture, Huh?

Here's a quick tutorial about screen captures, thus the title. If you're not sure what a screen capture is, then think about the pages you've seen lately. Maybe some of them have had specific sections of the desktop or a program made into an image. It was almost as if they captured part of the screen as an image.

Burns, Joe. HTML Goodies (2004). Articles>Documentation>Graphic Design>Screen Captures