A directory of resources inthe field of technical communication.

Documentation

626-649 of 1,430 found. Page 26 of 58.

About this Site | Advanced Search | Localization | Site Maps
 

« PREVIOUS PAGE 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50  NEXT PAGE »

Extreme documentation is an agile methodology for developing documentation in small to medium-sized teams in the face of vague or rapidly changing requirements.

 

626.
#21040

Microsoft "Longhorn" Help Highlights

Microsoft’s specification for 'Longhorn' Help represents a major revolution in user assistance development for the Windows platform. Instead of simply refining the technical infrastructure of Help (windowing, links, search, etc.), Microsoft has given a good deal of thought to the needs of both Help authors and end-users.

Ellison, Matthew. WritersUA (2003). Articles>Documentation>Operating Systems>Microsoft Windows

627.
#13782

Microsoft HTML Help SDK

Microsoft® HTML Help is the standard help system for the Windows platform. Authors can use HTML Help to create online help for a software application or to create content for a multimedia title or Web site. Developers can use the HTML Help API to program a host application or hook up context-sensitive help to an application. As an information delivery system, HTML Help is suited for a wide range of applications, including training guides, interactive books, and electronic newsletters, as well as help for software applications. HTML Help offers some distinct advantages over standard HTML, such as the ability to implement a combined table of contents and index and the use of keywords for advanced hyperlinking capability. The HTML Help compiler (part of the HTML Help Workshop) makes it possible to compress HTML, graphic, and other files into a relatively small compiled help (.chm) file, which can then be distributed with a software application, or downloaded from the Web.

Microsoft. Resources>Documentation>Online

628.
#21592

Microsoft Manual of Style 3.0  (link broken)

Complete styles and guidelines for publishing a variety of technical publications.

Microsoft (2002). Reference>Style Guides>Documentation

629.
#30813

Microsoft Manual of Style for Technical Publications  (link broken)   (PDF)

Understanding the user interface can be a confusing experience for customers. By using a consistent set of terminology and style, you can help customers navigate the product user interface successfully. Once customers become familiar with this system, they can jump seamlessly between content about different products.

Microsoft (2004). Books>Style Guides>Technical Writing>Documentation

630.
#20118

Migrating to WinHelp 4.0 for Windows ’95   (PDF)

WinHelp 4 is the help environment for Microsoft’s Windows 95 and Windows NT operating systems. Among the important new features of WinHelp 4 are more capable secondary windows, shortcut buttons, the ability to integrate multiple help files, What’s This? help, and better support for online coaches. Help authors must understand both the construction and the design aspects of these new features. They must also deal with the complexities of the transition from Windows 3.1 help to WinHelp 4.

Farkas, David K. and Joe Welinske. STC Proceedings (1996). Articles>Documentation>Online>Help

631.
#28788

Mike Brazill on Writing for Developers

Brazill gives tips for writers who document APIs or write other information for developers. He says that because developers are busy and want to get started, you have to write less and provide more examples. Developers are more goal-oriented than task oriented. He also explains the different levels of API writing.

Brazill, Mike and Tom H. Johnson. Tech Writer Voices (2007). Articles>Interviews>Documentation>Podcasts

632.
#28794

Mike Hamilton Gives Flare Demo to the STC Suncoast Chapter

Mike Hamilton from Madcap Software visited the Suncoast chapter in Tampa, Florida, and presented on Flare. In this presentation, he talks about the story behind RoboHelp and Macromedia/Adobe (this blew my mind). He also provides a lot of inside detail on Flare.

Hamilton, Mike and Tom H. Johnson. Tech Writer Voices (2007). Presentations>Documentation>Software>Madcap Flare

633.
#29444

A Millennial Paradigm for Documentation: the Scroll!

Although some zealots have proposed eliminating printed information entirely in favor of online help systems, Adobe Acrobat files, and even e-books, discarding printed books may prove less effective than simply modernizing them. Scrolls are the logical successors to books.

Hart, Geoffrey J.S. Geoff-Hart.com (2001). Articles>Documentation>Information Design

634.
#18768

Minimalism   (PDF)

In this wired, impatient world, our careers may depend on the ability to deliver minimalist documentation. The benefits are threefold: better readability, lower translation and printing costs, and easier reuse.

Kauffman, Ben. STC Proceedings (2002). Articles>Documentation

635.
#25848

Review: Minimalism and Documentation   (peer-reviewed)

What is minimalism? Is minimalist documentation 'risky,' and if so, what can be done to mitgate the risk? Was the structure of Windows 95's Help based on John Carroll's Minimalist Model or was 'the result' more a Microsoft business decision -- or a bit of both?

Eiler, Mary Ann. Kairos (1997). Articles>Reviews>Documentation>Minimalism

636.
#30523

Minimalist Strategies for Improving User Documentation   (PDF)

Those who use our products often ignore our best efforts at good documentation because they prefer to explore and learn by trial and error. Several researchers have developed document strategies that might help our users explore, learn, and recover from their errors. In order to use these strategies, however, technical communicators must get to know their users better, prototype their documentation, and test it on their users. Researchers need to tell us more about active learners and strategies for meeting their needs.

Elser, Arthur G. STC Proceedings (1993). Articles>Documentation>Quality>Minimalism

637.
#31777

Mistakes Can Be Costly

In the aircraft industry, a number of factors have converged to highlight the importance of maintenance manuals.

Between the Lines (2007). Articles>Documentation>Engineering>Risk Communication

638.
#21408

Mistakes Technical Writers Make   (Word)

Inexperienced technical writers typically make a number of avoidable mistakes, including parroting the SME and hard-coding xrefs. Here is a description of some mistakes to avoid.

Docsymmetry (2003). Articles>Documentation>Technical Writing

639.
#13186

Mobile Manuals for Mobile Professionals   (PDF)

PDAs raise new opportunities for technical communicators to provide corporate information in a compact, electronic package.

Buckley, Susan. STC Proceedings (2001). Presentations>Documentation>Online>Mobile

640.
#23167

Modelling Information, or Documentation Planning for Dummies   (PowerPoint)

Identify the user. Identify the user's goals. Drill down to task level. Establish what the user knows. Identify what the user needs to know. Identify what the user should NOT know.

Skau, Edwin. STC India (2003). Presentations>Documentation>Project Management

641.
#24841

A Modular Approach to WinHelp Projects: The Process Behind the Success   (PDF)

The Knowledge Products group at Cisco Systems, Inc., provides online help for both PC and UNIX-based applications. The online help team for the Cisco Works for Windows product comprised of five writers who coordinated the online help development efforts. The online help team worked closely to produce an integrated help system that was modularized for better process control.

Mandavilli, Lavanya K. STC Proceedings (1996). Articles>Documentation>Online>Help

642.
#24183

More Thoughts on Grassroots Documentation   (PDF)

I thought technical communicators could use grassroots documentation to measure the effectiveness of their in-house documentation. I've since learned that grassroots documentation is already in play—though not in the way I expected.

Martin, Maurice. Intercom (2004). Articles>Documentation>Community Building

643.
#24805

Moving Beyond Help   (PDF)

Users complain that there is too much information in help. We will explore ways to move beyond help and provide users with the types of support they really need: re-using information on commercial information services such as CompuServe or America Online, on the Internet, and on dial-up phone and fax services. Making application interfaces self-documenting. Providing information in overlaid notes, cue cards, and wizards.

Hyman, Francine N. and Jonathan R. Price. STC Proceedings (1995). Articles>Documentation>Online>Help

644.
#20076

Moving Documentation Online: Challenges and Opportunities   (PDF)

This panel explores the challenges faced both by computer companies and by their customers with the accelerating movement of putting documentation online. Panel participants will give their individual perspectives, followed by a discussion with the audience concerning the issues involved.

Smart, Karl L. STC Proceedings (1995). Articles>Documentation>Online

645.
#23739

Moving from Paper to Electronic Documentation: Tips for a Successful Project   (PDF)

With new tools and technologies available, more companies are choosing to move from paper-based documentation to electronic documentation. Being a pioneer is an exciting – and daunting – experience. In moving from paper-based to electronic documentation, you may be treading on a path never before explored for your product or your company. There are many decisions to make and many plans to develop, abandon, and develop again. Special attention is required in the areas of project management, writing and illustration, documentation design, and configuration management. A team that has experienced a paper-to-electronic documentation project can offer valuable advice if you are facing a groundbreaking project.

Finan, Jill Sutton, Joanna Natoli, Heather Healy and Mike Kocik. STC Proceedings (2003). Articles>Documentation>Online>Help

646.
#30799

Moving Legacy Documentation into DITA: An Interview

JoAnn Hackos, content management and information design expert, gives her best advice on what organizations need to know about moving legacy documentation to DITA.

Hackos, JoAnn T. Data Conversion Laboratory (2007). Articles>Documentation>Content Management

647.
#26308

Moving to DocBook   (PDF)

DocBook is a powerful tool for creating and maintaining documentation. However, there are a number of factors you should consider before you move your documentation to DocBook. This article discusses reasons for and against making the switch to DocBook.

Nesbitt, Scott. ScottNesbitt.net (2002). Articles>Documentation>Standards>DocBook

648.
#30079

Moving to Electronic Delivery of Documentation   (PDF)

'Moving to Electronic Delivery of Documentation' includes information about the fundamentals of electronic documentation, case studies, what to expect, how to research, identify, and implement a process for moving from an exclusively hard copy documentation development and delivery process to electronic documentation development and delivery.

Robertson, Angela and Sandy Storey. STC Proceedings (2000). Articles>Documentation>Online>Case Studies

649.
#31108

Musings on Structured, Topic-Oriented Authoring

A blog post that presents a few thoughts on using technologies like DITA to author documentation.

DMN Communications (2008). Articles>Documentation>XML>DITA

650.
#31109

Musings on User-Generated Documentation

User-generated documentation is a big issue in technical communication circles. If properly done, tapping into the knowledge of users can improve the quality and breadth of your documentation.

DMN Communications (2008). Articles>Documentation>Technical Writing>Wikis

 
« PREVIOUS PAGE  |  NEXT PAGE »

There are 10 readers currently online: 0 registered users and 10 guests. Register.Follow us on: TwitterFacebookRSSPost about us on: TwitterFacebookDeliciousRSSStumbleUpon