Extreme documentation is an agile methodology for developing documentation in small to medium-sized teams in the face of vague or rapidly changing requirements.
#19739
The Keys to Clarity, Consistency, and Correctness
How can you make documentation more clear, consistent, and correct for your users? Following are some guidelines I find effective when documenting concepts and organizing documents.
Hassell-Corbiell, Rives. Indus (2002). Articles>Documentation>Writing>Technical Writing
#31738
The Kind of Documentation Users Really Want
Have you ever asked your users what kind of training materials they want, or how they prefer to learn software? This kind of information is critical to figuring out what help deliverables to produce. But really when it comes down to it, there are only so many options — printed manuals, short guides, interactive flash guides, videos, online help, live training, reference cards, context-sensitive help, workbooks and exercises, or, usually the favorite, someone to stand by their computer and answer questions whenever they need help.
Johnson, Tom H. I'd Rather Be Writing (2008). Articles>Documentation>Usability>User Centered Design
#30279
KISMIF: Editing Your Own Manuals for Increased Usability 
Writers who must edit their own manuals for ease of use can adopt three basic principles for doing so. The first principle, 'give the user a map,' helps users find information in an unfamiliar manual. The second, 'start from the user's viewpoint, ' presents information in the order the user needs it. The third principle, 'keep it simple,' puts complex data in simpler terms and formats.
Femia, Jean W. STC Proceedings (1994). Articles>Documentation>Usability
#26825
KnowGenesis Online Forum for Technical Communication 
KnowGenesis is a forum to promote free exchange of thoughts, knowledge and literature in the field of technical communication. KnowGenesis is the dream shared by two technical communicators - Ginu George and Saurabh Kudesia. Their intense interest clubbed with knowledge collaboration led to the formation of KnowGenesis. The co-foundersí ideology is reflected in the way KnowGenesis is designed. KnowGenesis provides open access to all its content on the principle that making information freely available to the public supports a greater global exchange of knowledge.
Kudesia, Saurabh. International Journal for Technical Communication. Resources>Documentation>Online>Technical Writing
#26780
KnowGenesis Online Library for Technical Communication
KnowGenesis Library is India's first online library for Technical Communication. Within few months of its launch, KnowGenesis library is already creating waves in the international technical writing community. The library has more than 1200 important documents, reference materials, articles, e-books etc contributed by our members. KnowGenesis library is also partnering with Digital Curation Center UK for promoting digital preservation and is opening great opportunities for Indian technical writer to mark their presence in the international market. The information provided on the KnowGenesis library is FREE for all and just require a one time FREE registration (http://knowgenesis.org/tc/index.php?option=com_registration&task=register). There is no charge/fee whatsoever involved for using the library material. Registered users can submit their work to the library, browse through the large collection of material and can even volunteer for the administration.
Kudesia, Saurabh. International Journal for Technical Communication (2005). Resources>Documentation>Tools>Technical Writing
#18869
Knowledge Management, User Manuals, and Online Help: Tools for the Workplace
The three skills that technical writers most often need are an ability to elicit information from recalcitrant SMEs (Subject Matter Experts), the ability to put this information on paper (user manuals) and the ability to put it online in a Help system. This class will teach these skills. The first module will be an in-depth study on Knowledge Management, the second will be the creation of a user-centered manual using Word, Visio, and screen capture programs, and the last module will be transferring this information to an online Help using ForeHelp or RoboHelp.
Johnson, Carol Siri. New Jersey Institute of Technology. Academic>Courses>Knowledge Management>Documentation
#30513
KnowledgeWare's Online Odessey: How We Moved Our Printed Documentation to the Screen
Knowledge Ware successfully transferred existing paper-based documentation to an online format for the latest release of its Application Development Workbench(R) (ADW(R)) software. The online documentation solution, which runs under IBM's OS/2 operating system, was created using a series of macros developed in Microsoft Word 5.0. Using this strategy enabled Knowledge Ware to develop quickly an online system that met customer needs for information support. The system also enabled their technical writers to create both paper-based and online documentation using the same set of word-processed files.
Boland, Jennifer Ann. STC Proceedings (1993). Articles>Documentation>Online
#31353
Language Quality-Assurance Software
Explores the benefits of using Language QA Software to optimize documentation for organizations and companies.
Kohl, John R. Intercom (2008). Articles>Documentation>Software>Language
#19958
Large-Scale HTML Conversion Using a Word Processor
In 2000, the Hitachi Technical Information Department carried out a large-scale documentation project requiring the revision of 47 English manuals (about 15,000 pages) and production of the manuals in both paper and HTML formats. Many projects of this size would normally use more complex software and file formats, such as FrameMaker and SGML. However, most of the English manuals were already in Microsoft Word (hence forth 'Word') format, and we decided to use Word 2000 to convert the manual document files into HTML files directly. The presentation discusses solutions to problems encountered in this HTML conversion project.
Hara, Takayoshi and Mayumi Seitou. STC Proceedings (2001). Design>Documentation>Web Design
#28126
The Last Manual You'll Ever Need!
This UUGOM (Universal User Guide and Operation Manual) should help you get the most out of this product, any other PC World product, or any other product you may encounter.
Manes, Stephen. PC World (2004). Articles>Documentation
#30372
A Layered Approach to Translating Online Documentation
Localizing a large online documentation system is a significant, expensive, and ongoing project. SAP AG has adapted a layered approach to translation to help manage an online help system in 12 languages. This approach is based on an analysis of online documentation categories, and it is implemented by an analysis of the target markets. Technologies such as hypertext linking and text embedding need to be carefully controlled in order for this approach to be successful.
Elliott, Keith H. STC Proceedings (1993). Articles>Documentation>Translation>Localization
#14657
McGowan discusses how documentation departments can ease the transition from a paper-centered work environment to an online one.
McGowan, Kevin S. Intercom (2000). Design>Documentation>Online
#24369
Lessons Learned from Usability Testing of the Documentation
This presentation and demonstration will first establish the principles behind usability testing of the documentation, then show examples of lessons learned from testing both print and online documentation. Video clips of actual tests will be used to make some compelling points. The session will be especially useful to those who are interested in usability testing but haven't done it yet.
Barnum, Carol M. STC Proceedings (1998). Articles>Documentation>Usability>Testing
#30153
Let the User Write the Documentation
Teaching non-writers how to write can be challenging, especially when they are adults using new software to do their jobs. But who knows best how to write about their jobs than the end users. Through field experiences and case studies, this paper describes methods and approaches for eflectively including the end user in the documentation process, as well as educating experienced writers who are new to the system.
Doyle, Diane J. and Janet M. Samuelson. STC Proceedings (1997). Articles>Documentation>Education>Writing
#22160
Let's Stop Writing Documentation and Start Working for the Users
Nearly 20 years ago, the profession of technical communication began to focus on developing task-oriented documentation. Although task-oriented documentation has always been produced, particularly for consumer products, it was not the standard in the computer industry. More often, people writing about computer systems focused on the system rather than on the tasks people needed to perform. Systems-oriented documentation was the norm.
ComTech Services. Articles>Documentation>User Centered Design
#20725
Let's Stop Writing Documentation and Start Working for the Users
Technical communication's long-time focus on task-oriented documentation has left customers with too many tasks and too much information; itï¿Âs time for a new approach. A user-centered approach reflecting a thorough understanding of users and how they engage the product is the surest route to effective documentation and training. To understand what users need, we need to get closer to them by spending time in their workplaces, watching them execute everyday tasks, and listening to them. Through this kind of ethnographic activity, we will become user experts, gaining credibility within our own organizations and our user communities.
Hackos, JoAnn T. STC Proceedings (1999). Articles>Documentation>User Centered Design
#29861
Levels of Maturity in API Documentation
This paper proposes a set of API documentation maturity levels that can be used to define a writer or writing team’s ability to document technical materials and to set goals for moving between levels towards more independence from developers. It examines development and documentation team process maturity, as well as several types of API documentation, and their impact on writers new to producing developer documentation. The paper also discusses some of the common difficulties associated with developer-level documentation.
Kozlowski, Paula and Benjamin Dollar. STC Proceedings (2004). Articles>Documentation>Programming
#18915
Life Beyond Computer Documentation
In this paper we explore the title statement by examining some of the places in an industrial, business or educational organization where a technical communicator might reside as well as some of the numerous roles the communicator might play and the kinds of products the communicator might produce. The paper is intended to help young communicators see more clearly that their job need not be limited to the routine, the mundane, and the terminally boring, and to encourage them to see that the field of technical communication is far broader that just the production of computer documentation.
Wise, Daniel E. STC Proceedings (2002). Careers>TC>Documentation
#23391
With his back towards the reader, a bucket over his head, hands and feet tied up by SGML, CALS and company standards, and half choked by all the possibilities of the latest computer system the writer tries to produce manuals and instruction books for unsuspecting readers!
Forsslund, Lars. TC-FORUM (1998). Articles>Documentation>Writing>Technical Writing
#31084
Lightweight Literate Programming: A Documentation Practice
Lightweight literate programming (LLP) combines software documentation and coding in a way that can scaffold collaborations between technical communicators and programmers. We review the genesis and history of LLP, including its relationship to established single-sourcing methods. We then detail its use by programmers and discuss two models for writer/programmer collaboration using LLP. We finish by suggesting a few studies of working relationships between writers and programmers that LLP could facilitate.
Stavely, Allan, Lynda Walsh and John Shipman. Technical Communication Online (2008). Articles>Documentation>Programming>Methods
#21477
Linking Context-Sensitive HTML Help
The mechanism that Doc-To-Help uses for mapping topics in a context-sensitive HTML Help differs from the mechanism it uses for context-sensitive WinHelp. This article tells you what you need to know to properly link context-sensitive HTML Help to an application.
ComponentOne (1999). Articles>Documentation>Online>HTML
#19615
A website with resources for Linux documentation writers (and readers).
#18305
The Linux Documentation Project
The Linux Documentation Project (LDP) is working on developing good, reliable documentation for the Linux operating system. The overall goal of the LDP is to collaborate in taking care of all of the issues of Linux documentation, ranging from online documentation (man pages, HTML, and so on) to printed manuals covering topics such as installing, using, and running Linux.
Linux Documentation Project, The. Resources>Documentation>Style Guides>Linux
#30326
Listening: the Often Forgotten Ingredient
If listening isn't in the mix when developing documentation, then the project may not cook.
Allen, Clare. Boston Broadside (1992). Articles>Documentation>Collaboration>SMEs
#20364
Little Machines: Understanding Users Understanding Interfaces
This paper questions the ubiquitous practice of supplying minimalist information to users, of making that information functional only, of assuming that the Shannon-Weaver communication model should govern online systems, and of ignoring the social implications of such a stance. Help systems that provide fast, temporary solutions without providing any background information lead to the danger of users completing tasks that they do not understand at all. (Word will help us write a legal pleading, even if we have no idea what one is.) As a result, we have help systems that attempt to be invisible and to provide tool instruction but not conceptual instruction. Such a system presents itself as a neutral tool, but it is actually an incomplete environment, denying both the complexity and alternative (and possibly improved) modes of thinking about the subject at hand.
Johnson-Eilola, Johndan. Journal of Computer Documentation (2001). Articles>Documentation>User Centered Design>Usability
