Documentation Tools
-
Upload
raghunath-gautam-soman -
Category
Software
-
view
236 -
download
2
Transcript of Documentation Tools
![Page 1: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/1.jpg)
DOCUMENTATION TOOLSRaghunath Soman
![Page 2: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/2.jpg)
Contents
• Office Suites• Word Processors• Help Authoring Tools• Wikis• PDF Editors• Text Editors• HTML Editors• XML Editors• Image Capture/Editing Tools• Design/Graphics Tools• Audio/Video Editing Tools• Presentation Tools• Layout Tools
• Language Resources• Style Guides• Localization Tools• Review Tools• Code Documentation Tools• Mobile Documentation Tools• Database Documentation Tools• Cloud/Web-based Tools• Version Control Systems• Content Management Systems• Documentation tools for Linux• Niche Documentation Tools
![Page 3: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/3.jpg)
Office /Productivity Suites
• Apache OpenOffice [formerly known as OpenOffice.org]
• Apple iWork [Mac-only]
• Google Docs, Sheets and Slides [Web-based]
• Microsoft Office [Windows-only]
• Microsoft Office for Mac
• IBM Lotus Symphony [discontinued in 2012]
• Adobe Creative Suite
![Page 4: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/4.jpg)
Word Processors
• Apache Writer [part of Apache OpenOffice suite]
• Apple Pages [part of Apple iWork suite]
• Adobe FrameMaker
• Microsoft Word [part of Microsoft Office suite]
![Page 5: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/5.jpg)
Help Authoring Tools
• Adobe Robohelp
• Author It
• MadCap Flare
• Doc-To-Help
![Page 6: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/6.jpg)
Wikis
• Atlassian Confluence
• Jive
• MediaWiki
• TWiki
• IBM Connections
![Page 7: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/7.jpg)
PDF Editors
• Adobe Acrobat
• Foxit PDF Editor
• LibreOffice Draw
• Nitro PDF
• Most of the help authoring tools and productivity suites also support PDF as an output format.
![Page 8: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/8.jpg)
Text Editors
• NotePad ++ [Windows-only]
• vi [Windows, Linux]
• Text editors are particularly useful for read me files, short release notes, etc.
![Page 9: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/9.jpg)
HTML Editors
• Adobe Dreamweaver
• Google Web Designer
![Page 10: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/10.jpg)
XML Editors
• PTC Arbortext Editor
• Oxygen XML Author, Oxygen XML Editor
• XMetaL XML Author, XMetaL XML Editor
• Xopus DITA Editor
![Page 11: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/11.jpg)
Image Capture/Editing Tools
• GIMP
• FastStone
• SnagIt
• HyperSnap
• Paint.NET
![Page 12: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/12.jpg)
Design / Graphics Tools
• Adobe Illustrator [vector-graphics editor]
• Adobe PhotoShop [raster-graphics editor]
• Microsoft Visio [vector-graphics editor]
![Page 13: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/13.jpg)
Audio-Video Editing Tools
• Adobe Audition [part of Adobe Creative Cloud]
• Adobe Premiere Pro [part of Adobe Creative Cloud]
• Adobe Captivate
• Apple iMovie [Mac]
• Camtasia Studio
• Windows Movie Maker [limited set of features]
![Page 14: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/14.jpg)
Presentation Tools
• Apple Keynote [part of Apple iWorks suite]
• Microsoft PowerPoint [part of Microsoft Office suite]
• Google Slides [Web-based]
• Prezi [Web-based]
![Page 15: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/15.jpg)
Layout Tools
• Adobe InDesign
• CorelDraw
• Microsoft Publisher
• Scribus [open-source, cross-platform]
![Page 16: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/16.jpg)
Language Resources
• Purdue OWL - Purdue Online Writing Lab
• Thesaurus.com [online dictionary, thesaurus, translation]
• WordWeb [desktop dictionary]
![Page 17: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/17.jpg)
Style Guides
• Apple Publications Style Guide
• Chicago Manual of Style
• Cisco Technical Documentation Style Guide
• Elements of Style
• Google XML Document Format Style Guide
• HCi Style Guide for Technical Documentation
• IBM Style Guide
• ISO/IEC CD 18019: Guidelines for software user documentation
• Microsoft Manual of Style
• Mozilla Style Guide
• Documentation Style Guide for OpenSolaris
• NASA SP-7084: A Handbook for Technical Writers and Editors
![Page 18: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/18.jpg)
Localization Tools
• MadCap Lingo
![Page 19: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/19.jpg)
Review Tools
• Acrolinx
• Boeing Collaborative Document Reviewer (BCDR) [web-based document review application for aerospace industry documents]
• Collaborator
• XMetal Reviewer
![Page 20: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/20.jpg)
Code Documentation Tools
• Doxygen [generic source code documentation]
• Javadoc [Java API documentation]
• Sandcastle [.NET API documentation]
• phpDocumentor [PHP documentation]
![Page 21: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/21.jpg)
Mobile Documentation Tools
• sigil [creates EPUB files]
![Page 22: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/22.jpg)
Database Documentation Tools
• RedGate SQL Doc
• Turtle SQL [from CodePlex]
![Page 23: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/23.jpg)
Cloud/Web-based Tools
• Adobe Creative Cloud
• EtherPad
• Google Docs
• HelpIQ
• ZenDesk
![Page 24: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/24.jpg)
Version Control Systems
• Accurev
• Subversion (SVN)
• Microsoft Visual Studio Team Foundation Server
• IBM Rational ClearCase
• IBM Rational Team Concert
• Perforce
• Git [Linux]
• Microsoft Visual SourceSafe [almost obsolete]
![Page 25: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/25.jpg)
Content Management Systems
• EMC Documentum [enterprise-scale content management]
• DITA CMS [enterprise-scale DITA documentation process management]
• Drupal
• Joomla!
• Microsoft SharePoint
• WordPress
![Page 26: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/26.jpg)
Documentation tools for Linux
• OpenOffice Writer [word processors]
• GIMP, KSnapshot [screen capture]
• JavaHelp/JHelpDev, JHelpBuilder [online help]
• Javadoc, Doxygen, ROBODoc [source code documentation]
• DocBook XML, DITA Open Toolkit for Linux [XML]
• Git [version control system]
![Page 27: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/27.jpg)
Niche Documentation Tools
• LaTeX [document preparation system and document markup language, widely used for technical documents in many fields, including mathematics, physics, computer science, statistics, economics, and political science]
• Mathematica [computational software program used in many scientific, engineering, mathematical and computing fields]
![Page 28: Documentation Tools](https://reader031.fdocuments.net/reader031/viewer/2022020116/55a209fd1a28ab90368b45fd/html5/thumbnails/28.jpg)
Thank You
This content is for reference purpose only.
The lists are neither exhaustive, nor suggestive.
All product and company names are trademarks™ and/or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.
Batteries not included. Objects in mirror are closer than they appear. Keep out of reach of children. Avoid prolonged exposure to direct sunlight. Store in a cool dark place.