http://tc.eserver.org/dir/Resources/Documentation A listing of the most recently indexed works about Resources and Documentation in the field of technical communication. en-us Copyright (c) 2005-08 by the EServer. All rights reserved. tclib-editorial@eserver.org (TC Library Editorial Board) webmaster@eserver.org (Geoffrey Sauer) http://tc.eserver.org/images/newlogo.gif http://tc.eserver.org/dir/Resources/Documentation http://tc.eserver.org/34791.html http://tc.eserver.org/34791.html Defining quality means developing expectations or standards of quality. Standards can be developed for inputs, processes, or outcomes; they can be clinical or administrative. Unfortunately when it comes to documentation, many companies only focus on the standards related to time and accuracy. Quality standards should be in place for all aspect of the documentation development pathway—moving from planning, to authoring, to reviewing. http://tc.eserver.org/34769.html http://tc.eserver.org/34769.html This PDF is not a guide to any specific language, and so would be great for developers who do not code in any specific language (or who code in more than one language). http://tc.eserver.org/34657.html http://tc.eserver.org/34657.html This is our renewed screencast resource. We discuss software, techniques and technologies and offer suggestions and tutorials to create the best onscreen demonstrations. We also have a useful resource directory that hopefully may direct you towards the best screencast stuff online. http://tc.eserver.org/34472.html http://tc.eserver.org/34472.html The site is about Structured Authoring. That is a broad subject, but will focus on SGML and XML and the implementation. Tools used to author, manage, communicate and deploy data usually in the maintenance from some small widget to a large weapon system. Covering Mil-Stds and S1000D. http://tc.eserver.org/33746.html http://tc.eserver.org/33746.html A blog about publishing and technical communications. http://tc.eserver.org/33424.html http://tc.eserver.org/33424.html Often conflicting pressures to produce communications that better fit customer demands as well as stay within tightening constraints on budgets and schedules are leading many technical communications organizations to a topic-based approach to authoring. In fact, 58% of participants in Aberdeen Group's October 2008 DITA and the Technical Communicator’s Transformation study report that they currently follow author content in a topic-based manner, with a vast majority of those remaining planning to implement one in the future. A topic-based approach promotes greater content reuse and is seeing a considerable impact on the authoring efficiency of technical communications projects today. The benefits of topic-based authoring can be compelling, with findings from the The Technical Communicator’s Transformation study indicating that when pursued the right way, topic-based authoring can have a broad range of benefits, enabling an organization to meet authoring and localization cost targets as well as documentation quality expectations, among others. However, as the adoption of this approach spreads, the advantages seen by today's leading organizations will flatten out. This Sector Insight provides a guide for current adoption of topic-based authoring and those still considering it; outlining the changes that are expected to take place in as topic-based authoring goes mainstream. http://tc.eserver.org/32975.html http://tc.eserver.org/32975.html A collection of screen captures from online documentation, to permit technical writers and documentation designers to review a variety of visual styles. http://tc.eserver.org/32556.html http://tc.eserver.org/32556.html Your Writing Dept Blog is a collection of writings from technical writers who would like to develop dynamic, and hopefully, useful content when not creating technical documentation, user guides and training materials. The blog contains useful tips for how to work with a documentation team, and how to best manage documentation project. http://tc.eserver.org/32162.html http://tc.eserver.org/32162.html My name is Miranda, and I am an Information Developer (aka technical writer). I am the junior writer on my team, new to the company, and new to the industry. It’s safe to say, I’m the greenhorn. However, I have the honor to work beside some very experienced and very knowledgeable senior writers, so it’s only a matter of time before their good habits rub off on me. http://tc.eserver.org/31754.html http://tc.eserver.org/31754.html A searchable knowledge base of specifications for DITA users. http://tc.eserver.org/31582.html http://tc.eserver.org/31582.html This blog discusses documents and information designs “in the wild" - especially those that are exceptionally good or exceptionally bad. http://tc.eserver.org/31174.html http://tc.eserver.org/31174.html Kontinuierlich Nachrichten, Hintergrundberichte und Interviews rund um die technische Dokumentation und Redaktion, sowie die technische Übersetzung. In der Nachfolge der doculine news. http://tc.eserver.org/30729.html http://tc.eserver.org/30729.html Documentation is an important part of agile software development projects, but unlike traditionalists who often see documentation as a risk reduction strategy, agilists typically see documentation as a strategy which increases overall project risk and therefore strive to be as efficient as possible when it comes to documentation. Agilists write documentation when that's the best way to achieve the relevant goals, but there often proves to be better ways to achieve those goals than writing static documentation. This article summarizes common "best practices" which agilists have adopted with respect to documentation. http://tc.eserver.org/30404.html http://tc.eserver.org/30404.html You can use the Adobe Creative Suite 3 Video Workshop to start learning about any application you're interested in, whether you own it or not. The Video Workshop shares expertise from across Adobe and the Adobe community--you'll learn tasks, tips, and tricks from leading designers, developers, and Adobe experts. There are introductory videos for new users, and more experienced users can find videos on new features and key techniques. http://tc.eserver.org/29918.html http://tc.eserver.org/29918.html A weblog for writers of documentation and users of Help Authoring Systems. http://tc.eserver.org/29375.html http://tc.eserver.org/29375.html Known to write a script or two to automate repetitive tasks like help builds, she also likes to write posts about XML-based information models like Darwin Information Typing Architecture (DITA). She often experiments with online help technology, enjoys writing blog entries, and wants to find new ways to use communication to help people understand technical solutions to complex problems. http://tc.eserver.org/28774.html http://tc.eserver.org/28774.html The Method M blog for technical writers, marketing staff, product managers and others who spend hours each week creating documents. This blog is dedicated to helping you work more efficiently and create better documents. http://tc.eserver.org/28540.html http://tc.eserver.org/28540.html HAT-Matrix.com is a new representation of an old standard--the Help Authoring Tool (HAT) Comparison Matrix that was available from helpstuff.com for five years (2001-2006). But instead of a static list, this site uses a searchable database. And instead of someone choosing the tools that are included, vendors choose whether to include their tools. http://tc.eserver.org/28381.html http://tc.eserver.org/28381.html A weekly podcast for technical writers by a company called DMN Communications. http://tc.eserver.org/28077.html http://tc.eserver.org/28077.html A blog on documentation requirements of the InfoSec domain, security implications of documentation technologies, tools and practices, and the information security perspective on information standards with occassional blurbs of the writer's views and lessons in technical communication. http://tc.eserver.org/26951.html http://tc.eserver.org/26951.html It is important to offer the information that is needed by the user rather than focusing on the product and covering each function without regard to the user. http://tc.eserver.org/26894.html http://tc.eserver.org/26894.html The specifications for creating the eCTD Backbone Files and Study Tagging Files (techncal documents that follow the eCTD Specifications). http://tc.eserver.org/26825.html http://tc.eserver.org/26825.html 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. http://tc.eserver.org/26780.html http://tc.eserver.org/26780.html 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. http://tc.eserver.org/26192.html http://tc.eserver.org/26192.html These are XSL stylesheets for the DocBook DTD and its derivatives (Simplified DocBook, etc.) to generate PDF/print documents or Web/HTML content. http://tc.eserver.org/25846.html http://tc.eserver.org/25846.html Classic information for Windows Help authors. http://tc.eserver.org/25836.html http://tc.eserver.org/25836.html My client wanted screen shots in their CHM, but the screens were very large thus creating problems when printing a topic. With some help from Dave Gash, I got the large screen shots to open at 50% size, with a function for the user to resize them to 100% either all at once or one at a time. The function also toggled back to 50% at the user's discretion. This solved the problem of large screen shots in the online help, while allowing error-free printing to occur. http://tc.eserver.org/25831.html http://tc.eserver.org/25831.html Various articles, presentations, tips and hints on using AuthorIT. http://tc.eserver.org/25832.html http://tc.eserver.org/25832.html As other Help authoring tools (HATs) fall by the wayside or the scuttlebutt about their demise gets stronger, one HAT that continually gets favourable mention is AuthorIT. Maybe you've heard about it, but don't know what it is or how it is different from traditional HATs. In this article, I cover some of the main features of AuthorIT so you'll have enough information to investigate further. http://tc.eserver.org/25800.html http://tc.eserver.org/25800.html wikiHow is a collaborative writing project to build the world's largest how-to manual. With your contributions, we can create a free resource that helps people by offering clear, concise solutions to the problems of everyday life. http://tc.eserver.org/25442.html http://tc.eserver.org/25442.html DocBook is an XML vocabulary that is particularly well suited to books and papers about computer hardware and software. http://tc.eserver.org/25443.html http://tc.eserver.org/25443.html DocBook is officially available as a [WWW] Document Type Definition (DTD) for both XML and SGML. It is unofficially available in other forms as well. http://tc.eserver.org/25182.html http://tc.eserver.org/25182.html InfoSourcing's Persona based documentation approach allows our technical writers to prioritize their writing tasks and document the product to end users, who is going to use the product ..." http://tc.eserver.org/25135.html http://tc.eserver.org/25135.html Have you calculated the risks of outsourcing, and how do you find the best vendor and what would you outsource? http://tc.eserver.org/24644.html http://tc.eserver.org/24644.html Topics on technical communication written by experts in the field and posted online. http://tc.eserver.org/23723.html http://tc.eserver.org/23723.html The sites linked from this directory provide resources relating to design and desktop publishing. http://tc.eserver.org/23722.html http://tc.eserver.org/23722.html Many organizations have published their policy manuals online—the following are just a few online manuals that we've found. We don’t necessarily recommend these as good manuals, but they may provide some helpful ideas about content. http://tc.eserver.org/23326.html http://tc.eserver.org/23326.html A directory of hundreds of examples of online software documentation, categorized and rated by users. http://tc.eserver.org/22399.html http://tc.eserver.org/22399.html A technical writing/technical communication weblog with tips, tools and templates for technical writers. http://tc.eserver.org/21979.html http://tc.eserver.org/21979.html Technical publications departments in their infancy seem to have great difficulty producing documentation that is well designed and consistent in appearance throughout all documents. As the department matures, it attempts to "consistify" the appearance of the documentation, but, unless there is an experienced template designer on board, this is often a drawn-out process involving focus groups and much squabbling. Once the design is complete, however, it tends to be nearly identical to the templates designed by every other technical publications department in the world. Aside from a handful of design features that distinguish the look and feel of one company's documentation from that of its competitors, everything else is pretty much the same. Whether the focus group spends six months or two years designing templates, they all discover that a well-designed user guide contains some specific and standard design elements. http://tc.eserver.org/21481.html http://tc.eserver.org/21481.html ComponentOne maintains the WexTech-L discussion list as a place for our customers to discuss the Doc-To-Help Legacy products, and provide peer-to-peer support. List subscribers range from certified Doc-To-Help consultants and trainers to users who have just started working with a newly downloaded evaluation copy. Discussions on the WexTech-L list range from quick, simple question-and-answer exchanges to lively threads on Help authoring, printing manuals, and other topics of interest. On an average day, about 20-30 messages are sent to the WexTech-L list. http://tc.eserver.org/21300.html http://tc.eserver.org/21300.html The TechScribe newsletter is designed primarily for purchasers and potential purchasers of technical writing services. It deals with legislation, new products on the market, new services, tools, hints and tips and other matters relating to documentation and a client's business. Of course, it will also keep you updated with what's happening at TechScribe. http://tc.eserver.org/20886.html http://tc.eserver.org/20886.html The following general resources are Web sites of interest to Help authors, technical communicators, and programmers. http://tc.eserver.org/20702.html http://tc.eserver.org/20702.html Examining documentation and help systems for software and consumer products. http://tc.eserver.org/20036.html http://tc.eserver.org/20036.html Die Inanspruchnahme der Foren und das Einstellen von Beiträgen ist ohne Registrierung möglich. http://tc.eserver.org/20032.html http://tc.eserver.org/20032.html RoboHelp is the industry's top-selling Help authoring tool. Designed for WinHelp and Microsoft HTML Help, RoboHelp can also be used to produce WinHelp 2000, WebHelp, JavaHelp, and Oracle Help for Java. http://tc.eserver.org/19615.html http://tc.eserver.org/19615.html A website with resources for Linux documentation writers (and readers). http://tc.eserver.org/19618.html http://tc.eserver.org/19618.html A set of threaded discussion forums for technical writers and software documentation specialists. http://tc.eserver.org/19356.html http://tc.eserver.org/19356.html A guide to using the Chicago Style for writing. http://tc.eserver.org/18587.html http://tc.eserver.org/18587.html Contains news and information on software and documentation issues, reports on survey into the current trends in technical communication, the future of Help / trends in user assistance, which Help authoring tool to buy, an introduction to single-sourcing, career advice, etc. http://tc.eserver.org/18507.html http://tc.eserver.org/18507.html Un manuale o una guida in linea efficaci non nascono semplicemente dalla competenza tecnica: il contenuto deve essere rivestito da una forma che ne faciliti la comprensione e la memorizzazione da parte dell'utente. Esistono collaudate strategie per la costruzione di testi, illustrazioni, percorsi concettuali: queste strategie sono elaborate da esperti di psicologia, pedagogia, linguistica e altre discipline. http://tc.eserver.org/18305.html http://tc.eserver.org/18305.html 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. http://tc.eserver.org/14810.html http://tc.eserver.org/14810.html A bibliography that presents major works on topics discussed in the book <i>Inside Macintosh: Macintosh Human Interface Guidelines</i>. http://tc.eserver.org/14120.html http://tc.eserver.org/14120.html A news site with news about technical documentation issues. http://tc.eserver.org/13783.html http://tc.eserver.org/13783.html JavaHelpTM software is a full-featured, platform-independent, extensible help system that enables developers and authors to incorporate online help in applets, components, applications, operating systems, and devices. Authors can also use the JavaHelp software to deliver online documentation for the Web and corporate Intranet. http://tc.eserver.org/13781.html http://tc.eserver.org/13781.html Online help facilities are an important part of any software product in today's marketplace. Apple has a number of technologies specifically designed for providing both convenient to use and easy to understand online help. Interested developers can take advantage of these technologies and use them to build online help facilities into their own products. This page provides an overview of the current Apple help technologies along with links to other related resources. http://tc.eserver.org/13782.html http://tc.eserver.org/13782.html 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. http://tc.eserver.org/13780.html http://tc.eserver.org/13780.html Here you will find the world's largest collection of standalone WinHelp Authoring Tools (HATs).If you have heard about any other HAT freeware or shareware please tell me about it. http://tc.eserver.org/13778.html http://tc.eserver.org/13778.html For developing HLP files you do not need so much. In fact: All absolutely needed tools are available with no charge. http://tc.eserver.org/13776.html http://tc.eserver.org/13776.html This comprehensive, up-to-date list is your one-stop link to the brightest and best resources in the Help world—all the tools, contacts, and information you'll need to develop thorough, effective, polished Help projects. http://tc.eserver.org/13673.html http://tc.eserver.org/13673.html A page about each of the major online Help technologies: HTML Help, JavaHelp, WebHelp, WebWorks Help, WinHelp, and WinHelp 2000. http://tc.eserver.org/13647.html http://tc.eserver.org/13647.html The following list is for resources related to the production of online help and for discussion of online communication in general. The Online Help section was originally for Windows Help only, but can now be taken to include other forms of online help, such as HTML Help and JavaHelp. http://tc.eserver.org/10183.html http://tc.eserver.org/10183.html The place to find the hottest news and tips on how to make user friendly instruction manuals and control the quality of instruction manuals.