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
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
A website with resources for Linux documentation writers (and readers).
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
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.
A set of threaded discussion forums for technical writers and software documentation specialists.
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.
Comolli, Fabrizio. ErgoSum (2002). (Italian) Resources>Documentation>Regional>Italy
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.
Online Documentation and Online Help
A bibliography that presents major works on topics discussed in the book Inside Macintosh: Macintosh Human Interface Guidelines.
Apple Inc. (1996). Resources>Bibliographies>Documentation>Online
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.
Have you calculated the risks of outsourcing, and how do you find the best vendor and what would you outsource?
Info Sourcing (2004). Resources>Documentation>Outsourcing>Offshoring
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 ..."
Sarjapur, Harsha. Info Sourcing (2005). Resources>Documentation>User Centered Design>Personas
Policy and Procedure Manuals Online
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.
Technical Communicators Resource Site (2004). Resources>Directories>Documentation>Policies and Procedures
Classic information for Windows Help authors.
Carroll, John M. PC Users Group (1995). Resources>Documentation>Online>Help
Die Inanspruchnahme der Foren und das Einstellen von Beiträgen ist ohne Registrierung möglich.
Robo-Forum. (German) Resources>Documentation>Software>RoboHelp
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.
Knopf Online (2003). Resources>Documentation>Software>Adobe RoboHelp
Standalone Help Authoring Tools
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.
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.
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.
TechScribe (2003). Resources>Mailing Lists>Documentation>Technical Writing
Kontinuierlich Nachrichten, Hintergrundberichte und Interviews rund um die technische Dokumentation und Redaktion, sowie die technische Übersetzung. In der Nachfolge der doculine news.
Transline. (German) Resources>Documentation>Technical Editing>Blogs
Examining documentation and help systems for software and consumer products.
Meyer, Gordon R. Usable Help. Resources>Documentation>Usability>Help
User Assistance Resource Directory: Web Resources 
The following general resources are Web sites of interest to Help authors, technical communicators, and programmers.
'User Friendly Manuals' Website
The place to find the hottest news and tips on how to make user friendly instruction manuals and control the quality of instruction manuals.
A Visual Guide to Document Design and Layout 
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.
Amott, Lyndsey. Docsymmetry (2003). Resources>Style Guides>Design>Documentation
There are 14 readers currently online: 1 registered user and 13 guests. Register.

![]()
![]()


![]()
![]()
![]()