#14551
Using Word to Create Windows Help 
One way to create Windows help is by using Word for Windows. To begin, you must become familiar with the help concepts of topics and hyperlinks. Then, you create these components: projectile, header file, and source files. Source files are created using Word for Windows. Next create the actual help file by compiling the elements you have created. Finally, view and debug the results.
Van Sant, Carol J. STC Proceedings (1995). Presentations>Documentation>Help>Online
#13682
Walking Through the Fires: A Case Study of Implementing a Formal Documentation Development Process
The need for a more comprehensive documentation development process at Computerized Medical Systems, Inc. (CMS) was identified in an annual year-end review meeting of the CMS User Documentation Section. The goal was set to develop and implement such a process. A key component would be a set of comprehensive Content Specification Guidelines. Initial research consisted of reviewing existing literature and compiling a list of information considered essential to effectively plan a documentation project at CMS, based on discussion with software developers and technical communicators as well as experience gained from previous projects. The new process was implemented and has provided benefits throughout the company.
Watson, Frank. STC Proceedings (1999). Presentations>Documentation>Management
#13169
Wayfinding in Small Spaces: How to Create Job Aids
Users reach for job aids for a range of reasons, from recalling the highlights of a task, to finding codes that are used infrequently. The compact size offers safe harbor after working through a detailed user’s manual. Creating a job aid, however, is quite time-consuming. You must select the content, then concisely and elegantly incorporate key tasks and codes. Finally, you need to produce the job aid in a functional format. The hardest task of all is to sell job aids to management. You need to sell productivity and results, not size. After all, good things come in small packages.
Lisberg, Beth Conney. STC Proceedings (2000). Presentations>Documentation
#18795
WebWorks Publisher 7 Tips and Tricks
A presentation describing techniques for Adobe FrameMaker and WebWorks Publisher users.
Knopf, David A. Knopf Online (2002). Presentations>Software>Documentation>Adobe FrameMaker
#28750
When in Rome: Describing an API in its Own Terms with DITA 
To tame the API beast, a successful description must: be accurate and complete (of course); take the perspective of the programmer who's going to use the class.
Hennum, Erik and Mariana Alupului. STC Proceedings (2006). Presentations>Documentation>Standards>DITA
#14352
Where is the Instruction in Online Help? Designing it Right the First Time
One of the ironic things about online help systems is that they are very often not helpful and even increase the user's frustration and stress level. A consequence of this increased frustration sometimes results in the rejection of the software. One solution is to increase the effectiveness of online help systems by designing them from an instructional design perspective. Some of the things we can provide users include: imperative, task-focused procedures; graphic feedback; access to redundant instructions; links to tutorial practice; philosophical and conceptual explanations for “why” they are completing specific tasks.
Pratt, Jean A. STC Proceedings (1997). Presentations>Documentation>Instructional Design>Help
#28754
Wikis Are Coming: An In-Depth Exploration of Using Wikis in Documentation
In this podcast, Katriel Reichman, a technical writer at Method M in Jerusalem, Israel, talks in-depth about how to use wikis for documentation.
Reichman, Katriel and Tom H. Johnson. Tech Writer Voices (2007). Presentations>Documentation>Content Management>Podcasts
#13392
Working with Government Documentation Standards: A Case Study
This paper discusses the software development process at a particular government agency, the documentation standards used by that agency, the problems caused by these standards, and some of the solutions that have helped the technical communication there to work through the problems and still create documents of use to the reader.
Chiricosta, Tracey C. and Irene Lea Taylor. STC Proceedings (1993). Presentations>Documentation>Style Guides>Government
#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
#13151
You Get What You Measure—So Measure Quality
We use an Excel workbook to record information about the documents we produce. Originally created to assign document order numbers, we have added to it many categories of process data. It now provides valuable management and tracking information. More importantly, by recording and measuring completion of our critical processes, we reinforce and encourage use of best practices. I kept the rows in chronological printing order, which directly tracked our output. However, because of the order number structure (3), sorting by order number grouped documents by product, title, and revision. Sorting on other columns yielded lists of documents by product, by release, by writer, or by month. Gradually, as we introduced new group processes, I recorded new information about our documents.
Jong, Steven F. STC Proceedings (2000). Presentations>Documentation
#13147
You’re Not in Kansas Anymore! Documentation in the Real World
Most planning methods do not account for the time and resource crunch that is a reality in today’s high-tech companies. However, there are techniques that you can use in all stages of a project that allow you to complete quality software documentation on time. Prepare to write the documentation by initiating pre-project activities, such as building relationships with developers, creating an outline, and participating in interface design development. Incorporate reviews and prioritize your work throughout the writing cycle. Address production and document management methods early on, and after completing the project, continue to solicit feedback from users and colleagues.
Stehney, Heather and Cristina Ward. STC Proceedings (2000). Presentations>Documentation
#32683
Becoming an API Writer: How I Learned to Stop Worrying and Love Developers
If you know API writing, there is greater demand for your skills, that is, there are more jobs to which you can apply. At the same time, there is a shortage of API writers. API writers tend to work more closely with development, instead of through product management or product definition or through specs. You are closer to those who design the product, privy to design decisions -- closer to the action.
Wroblewski, Daniel. STC Proceedings (2008). Presentations>Documentation>Writing>Technical Writing
#33731
Creating Documentation With A Wiki: The DITA Storm Project
DITA is natural. Do XML/DITA conversion research now. Wiki is especially good for iterative writing. Structured wiki authoring in coming.
Abel, Scott. SlideShare (2007). Presentations>Documentation>Wikis>DITA
#34063
Think Simple: A Fresh Approach to User Assistance
Online help. User assistance. That thing that pops up when you press F1. No matter what you call it, user assistance is an important element in the experience of a user. It can mean the difference between a frustrated user and a productive one. But is today's user assistance all it can be? Are we giving users purposeful information at the right time, in the most effective format, and ultimately in the way that they need it? Unfortunately, no.
Davis, Aaron and Scott Nesbitt. DMN Communications (2009). Presentations>Documentation>Online>Help
#34420
WinHelp, WebHelp, AIR... Help!
Online formats can be confusing—consider "WebHelp" vs. "Web Help." This session describes XML, XHTML, HTML Help, WebHelp, DotNet Help, AIR, and others—and how to select the appropriate one.
Perlin, Neil E. STC Proceedings (2009). Presentations>Documentation>Help
#34610
Changing how we write, manage, and publish; how we relate to management and customers, and do business.
Bailie, Rahel Anne. SlideShare (2009). Presentations>Documentation
#34861
Open Source Documentation Doesn't Have to Suck
In open source, the standards for documentation are typically quite low. But they don't have to be.
SlideShare (2009). Presentations>Documentation>Quality
#35108
The notes for a presentation (titled Thinking Outside the Book: Wikis for Writing and Delivering Documentation, that discusses the whys, the tools, and the techniques of using wikis for documentation.
Scott Nesbitt. DMN Communications (2009). Presentations>TC>Wikis>Documentation
#35322
A Comparison of Three Visual Help Authoring Tools
What Are These Tools? Screen recorders that let you: record a series of screens as frames in a movie – like chaining together screen shots; annotate the frames with text captions, high-lights, and other effects for enhanced learning and explanation; add testing – informally through “dead-end” quizzes or formally using eLearning; publish the result.
Perlin, Neil E. SlideShare (2007). Presentations>Documentation>Software>Help
#35334
Move Over Text: Video Documentation Meets DITA
In the US today, there are 82.5 Million Content Creators 13.9% create content in virtual worlds 18.1% create video content 23.9% create blog content 79.7% create content on a social network. All we need is a standard that will support the topic- based nature of “how to” video content XML, and by extension, DITA, seemed to be a perfect fit.
Abel, Scott and Sean Healy. SlideShare (2009). Presentations>Documentation>Multimedia>Video
#35338
Analyzing Your Deliverables: Developing the Optimal Documentation Library
Web 2.0 includes: wikis, podcasts, blogs, widgets/gadgets, social networks … and combinations of all the above. Not everyone contributes equally – Creators (18%), Critics (25%), Spectators (48%). But all are important.
Bleiel, Nicky. SlideShare (2007). Presentations>Content Management>Documentation>Help
#35435
What does structured authoring mean to you? Structured authoring is a publishing workflow that lets you define and enforce consistent organization of information in documents, whether printed or online. What it means to me: defining a goal and assembling architected topics to help the reader achieve that goal.
Vazquez, Julio J. SDI Global Solutions (2009). Presentations>Documentation>Information Design>DITA
#35436
Managing a Documentation Project: A Guide
This a short video overview of managing a documentation project. It's something we put together as a test of some of the functionality of Techsmith's Camtasia software.
Pratt, Ellis. Cherryleaf (2009). Presentations>Documentation>Project Management
#35468
Keep It Simple: Streamline Your Documentation to Make it More Effective
Are we giving users the help they need, in the way they need it? Go minimal.
Nesbitt, Scott. SlideShare (2009). Presentations>Documentation>Minimalism
#35802
Embedding Videos into Madcap Flare 
One of Flare’s shortcomings is the inability to easily embed video files. However, if you use the Camtasia Studio’s Express Show format as your video format (and you choose the SWF option), you can insert the video into Flare by inserting the video as if it were a picture. Here’s a two-minute screencast showing the processing for inserting a video into Flare. You can also put the video in a drop-down hotspot.
Johnson, Tom H. I'd Rather Be Writing (2009). Presentations>Documentation>Screencasts>Madcap Flare
