documentation tools

DOCUMENTATION TOOLS-Gautam Soman1

bytespace.blogspot.com

INTRODUCTION Technical Writing usually involves use of

sophisticated tools. Each tool has its own strengths and limitations. A tech writer needs to choose a tool by taking

into consideration the type of the application, the type of the end deliverable, the target audience, and of course, the customer’s preference.

This presentation discusses major categories of tools, and the major choices in each category.

You can visit the homepage for each tool by clicking its hyperlink. 2


CATEGORIES OF TOOLS Word Processing Tools Help Authoring Tools Screen Capture Tools Image Processing Tools Video Editing Tools HTML Editing Tools Code Documentation Tools Content Management Tools

3


WORD PROCESSING TOOLS MS-Office Open Office

4


http://office.microsoft.com/

http://www.openoffice.org/

HELP AUTHORING TOOLS Adobe RoboHelp DocToHelp Madcap Flare

5


http://www.adobe.com/products/robohelp/

http://www.doctohelp.com/

http://www.madcapsoftware.com/products/flare/overview.aspx

SCREEN CAPTURE TOOLS SnagIt FastStone PrintScreen

6


http://www.techsmith.com/screen-capture.asp

http://www.faststone.org/

http://www.gadwin.com/printscreen/

IMAGE PROCESSING TOOLS Adobe PhotoShop

PaintShopPro GIMP

MS-Visio

7


http://www.adobe.com/products/photoshop/photoshop/

http://www.corel.com/servlet/Satellite/us/en/Product/1184951547051#tabview=tab0

http://www.gimp.org/

http://office.microsoft.com/en-us/visio/

VIDEO EDITING TOOLS Camtasia Studio Adobe Captivate Wink

8


http://www.techsmith.com/camtasia.asp

http://www.adobe.com/products/captivate/

http://www.debugmode.com/wink/

HTML EDITING TOOLS Adobe Dreamweaver Microsoft FrontPage

9


http://www.adobe.com/products/dreamweaver/

http://office.microsoft.com/frontpage

CODE DOCUMENTATION TOOLS SandCastle NDoc JavaDoc Doxygen PHP Documentor

10


http://shfb.codeplex.com/Wikipage

http://ndoc.sourceforge.net/

http://java.sun.com/j2se/javadoc/

http://www.doxygen.org/

CONTENT MANAGEMENT TOOLS Digite

Documentum Tortoise SVN

SharePoint Server

11


THANK YOU! This presentation is based on a blog-post

written by Gautam Soman. You can read the complete article at ByteSpace

Gautam Somanhttp://www.gautamsoman.com 12


documentation tools

Documents