#22651
Your product is almost ready for release. You're about to pat yourself on the back when you realize that you have no user documentation! Panic sets in.
Nichols, BeLinda. Webmonkey (2000). Design>Web Design>Documentation
#21709
XML provides a robust, non-proprietary, and verifiable file format for the storage and transmission of text and data both on and off the Web. XML removes the complexity of SGML, making it easier to define your own document types, and to write programs to handle them.
Bokil, Manoj. STC India (2003). Articles>Documentation>Information Design>XML
#31615
The XML train is finally pulling into the station. It brings an ocean change in the way we create, store, and manage information. In October of last year, Microsoft released Office 2003, which brings the promise of XML to the desktop. Previously, Word 2000 saved only the Properties of documents in an XML module in files converted to HTML. In this new edition, you can save or export all Office documents as XML documents. Using XML tags, we can now identify various elements of our documents for manipulation, storage, and retrieval as you would data in a data bank. It also enables us to more easily share information in those documents across other applications (including Web applications), networks, and operating systems.
DuBay, William H. Impact Information (2005). Articles>Document Design>XML>Microsoft Word
#29300
XML Paper Specification (XPS) of a Word 2003 Document
Microsoft breathed new life into legacy office documents by opening an XML window (Office Open XML) to its office products through its royalty-free XPS specification. XPS stands for XML Paper Specification that specifies cross-platform, open standard, document representation that can be used for generating, sharing, printing and archiving of paginated documents. Its virtues in Microsoft's own words are, "With XPS, documents print better, can be shared easier, be archived with confidence, and are more secure."
Krishnaswamy, Jayaram. ASPAlliance (2007). Articles>Document Design>XML>Microsoft Word
#13946
"Yes, But Does it Scale?": Practical Considerations for Database-Driven Information Systems 
This paper explores the process of designing and implementing a database-driven system of online documentation, and putting it live on the web for customers to use. Using real-life examples, it discusses practical considerations for balancing performance, scalability, and reliability.
Russell, John. ACM SIGDOC (2001). Presentations>Information Design>Documentation
#21911
You Get What You Pay For...Sometimes 
Buying the quality you need isn't just a matter of checking the price tag.
Sidles, Constance J. Adobe Magazine (1997). Design>Document Design>Prepress>Paper
#24897
Your Document Covers the Facts, But Does It Keep ’Em Coming Back?
Much technical documentation merely describes the features or appearance of a product or service, leaving readers uninspired and disinterested. In fact, much of what we write probably never gets read. A combined audience, task, and benefits analysis can help us communicate why a user should do a task—not just how to do it.
Fritz, Anne, Jason R. Huntington, Bruce Knorr, and Judith Leetham. STC Proceedings (1995). Articles>Document Design>Usability
#32096
Structured Writing, Structured Documentation: What and Why?
A brief comparison of two often-confused concepts.
West, Mike. MBWest.com (2007). Articles>Documentation>Information Design
#32144
In my work with Bumblebee I use an approach I call 'User-Guide-Driven Development,' or UGDD for short. The mechanics of UGDD is similar to that of Test-Driven Development (TDD), but before I write the test for a feature, I write a snippet of the user guide describing the feature I am about to implement.
Brolund, Daniel. Thoughts of a Goldfish (2008). Articles>Documentation>Usability>User Centered Design
#32171
If you document everything, you are giving everything an equal weight. Do that for a complex system, and you are buried in detail. In any system there are some aspects that are more important than the others, key aspects of the system that once understood, will help someone to learn more. The art in documentation is to find how to document these aspects as clearly as possible. In this you emphasize these areas, and leave the details for the code.
Fowler, Martin. Distributed Computing (1997). Articles>Documentation>User Centered Design>Minimalism
#32349
Users Read Help Manuals Like an Encyclopedia, Not a Novel
Users turn to help to look for a specific question, just as someone consults an encyclopedia for a specific question. No one reads the entire encyclopedia/manual, nor is anyone expected to. Well-written encyclopedias allow users to find information through indexes, tables of contents, alphabetical organization, and search fields.
Johnson, Tom H. I'd Rather Be Writing (2008). Articles>Documentation>User Centered Design>Help
#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
#32540
Documenting User-Centered Design Best Practices
When initiating or expanding the role of user-centered design (UCD) in an organization, consider documenting UCD best practices as they fit within existing processes and the best practice of other areas. Such documentation communicates the role and value of UCD throughout the organization in terms familiar to your organization. Because what best practices means varies from company to company, there is no single way to do this. Here are some questions to consider.
Bachmann, Karen L. STC Proceedings (2008). Articles>Documentation>User Centered Design>Policies and Procedures
#32560
Small Caps in InDesign CS3 and QuarkXPress 7
We previously discussed small caps and the importance of using true-drawn versions rather than computer-generated, “fake” ones. Many of today’s OpenType fonts include true-drawn small caps, making it easier than ever to take advantage of this typographically sophisticated feature, but the OpenType interface in both Adobe® InDesign® CS3 and QuarkXpress® 7 can be a bit confusing.
Strizver, Ilene. Upper and lowercase Magazine (2008). Articles>Document Design>Typography>Adobe InDesign
#32561
Will the “Real” Garamond Please Stand Up
Garamond typefaces, in both their American and European flavors, are generally considered ideal book faces. The design is also an excellent choice for most other forms of continuous text. Magazines, newsletters, annual reports, lengthy advertising copy – for example – are all naturals for the Garamond design.
Illuminating Letters (2008). Design>Document Design>Fonts>Typography
#32562
Hung Punctuation and Optical Margin Alignment
Even with all the technology at the disposal of today’s designers, in the end it’s what the human eye sees that counts. That’s why hung punctuation is one of the skills to master when you’re ready to add professional finesse to your typography. Learn what hung punctuation is and how to achieve it in the leading page layout applications.
Strizver, Ilene. Upper and lowercase Magazine (2008). Articles>Document Design>Typography
#32563
Double Spaces Between Sentences…NOT!
Typing two spaces after a period is a relic of the typewriter era that has hung around long past its sell-by date. Here’s how to make sure none of those double-space dinosaurs find their way into your typeset work.
Strizver, Ilene. Upper and lowercase Magazine (2008). Articles>Document Design>Typography
#32564
Automatic, or manual? No, we’re not talking about transmissions - we’re talking about bullet lists, those frequently used tools for organizing lists of information. Your layout application will be happy to format these lists for you, but for true typographic finesse, it’s time to learn to “drive stick” and call your own shots about bullets, alignment and spacing.
Strizver, Ilene. Upper and lowercase Magazine (2008). Articles>Document Design>Typography
#32568
Breaking up isn’t hard to do – just do it right so you don’t lose face. Learn why making the right line breaks in display type is essential for good looks and good sense.
Strizver, Ilene. Upper and lowercase Magazine (2008). Articles>Document Design>Typography>Usability
#32571
InDesign Shortcuts: Special Characters
The keyboard is rarely the friendliest path to symbols and special characters. Sometimes a bit of menu magic can guide you past the overwhelming Glyph palette. Indeed, the Special Character flyout palette in Adobe InDesign CS3 is a great shortcut to frequently-used characters and will spare your fingers the keyboard contortions.
Strizver, Ilene. Upper and lowercase Magazine (2008). Articles>Document Design>Typography>Adobe InDesign
#32572
Powerful design software makes many choices available to graphic designers, but just because you can do something doesn’t always mean you should. For example, sometimes it’s a good idea to convert your text layouts to outline, but sometimes it isn’t. Learn more about this occasionally necessary, often ill-advised practice before you decide whether or not it’s time to convert.
Strizver, Ilene. Upper and lowercase Magazine (2008). Articles>Document Design>Typography>Graphic Design
#32574
OpenType Numerals in InDesign and Quark
Today’s OpenType fonts come equipped with a virtual buffet of numeral styles, but all those choices can be a bit much for your design application to swallow. Here’s a practical guide to help you find your way through the maze of oldstyle, lining, proportional, and tabular, in both InDesign and Quark.
Strizver, Ilene. Upper and lowercase Magazine (2007). Articles>Document Design>Typography>Adobe InDesign
