Open Source Tools for User Assistance

Exploring Open Source Tools for User Assistance Mike McCallister (ProTek Writing Services) [email_address]

Tool Demonstrations & Reviews
What is open source software?

Definitions
Open Source: http://opensource.org/docs/osd
Focused on what developers offer.
Allow derivatives, free redistribution.
Free Software: http://www.fsf.org/licensing/essays/free-sw.html
"Free software is a matter of the users' freedom to run, copy, distribute, study, change and improve the software."
Focused on what user can do.
Freeware/Shareware
"Free beer": Any software charging $0.
Beware of potential malware!

So What Are We Talking About?
Content development tools
OpenOffice.org: Words, presentations, etc.
Scribus: Desktop publishing, page layouts
TeX: Document processor, semi-structured text
Graphics tools
The GIMP: Raster graphics
Inkscape: Vector graphics

OpenOffice.org
5 applications
Writer word processor – similar to Word, WordPerfect
Draw vector graphics tool – similar to Illustrator, CorelDRAW
Impress presentation – similar to PowerPoint
Calc spreadsheet – similar to Excel
Base database – similar to Access
ODF OASIS standard
AutoExport to PDF
Some configuration possible

OOo Writer vs. FrameMaker vs. Word Writer FrameMaker Word Master documents Book files Master documents Conditional text Conditional text Limited conditional text support Direct PDF export Acrobat Distiller PDF plug-ins available. Cascading styles Structure available Cascading styles; Strong outline tool Simple list numbering Simple list numbering Field codes

OOo Writer Navigator
Outline tool
Configurable headings
Drag-n-drop
Quick go-to
Tables
Graphics
Hyperlinks
Move it out of your way

OOo Writer/Web
For HTML-based support
Cleaner code than Word
XML Forms Wizard
Simple controls in toolbar
Gallery provides backgrounds, bullets, and sounds
Preview in (default) browser

Scribus
Page layout / Desktop publisher
Create text and graphics elsewhere, then import
Good for (short) manuals, quick reference guides, dynamic PDF
Export to print, PDF
Careful: Default templates in A4

Scribus

Created for UNIX CLI, LyX is the GUI
Fully separates presentation from text
WYSIWYM: What you see is what you mean
Exports to ODF, PDF, HTML
Terrific equation editor
Excellent documentation

LyX Terminology
Document Classes: Templates
Article (default)
Book: Article with Chapters
Letter
Report
Weakness: No "user manual" class. No DITA or DocBook XML support.
Environments: Styles
Strictly enforced by document class

Open Source Graphics: The GIMP
Open source Photoshop
Raster graphics (JPG, PNG)
Layers
Screenshots
Beginning to support CMYK color rendering through GEGL

GIMP vs. Photoshop GIMP Photoshop Layer styles Layers Scripts, not macros Macro recording tool Many useful plug-ins Massive developer community writing add-ons GimpShop available, but not current Uses different terminology GIMP is great if it’s your first editing tool, but Photoshop experts may not find their skills transferable

Open Source Graphics: Inkscape
Open source Illustrator/CorelDRAW
Scalable Vector Graphics
Layers
Callouts & text boxes
Flowcharts
Built-in IM support client

What Are Scalable Vector Graphics?
W3C Standard XML
Attributes can be indexed and searched
Inkscape contains an XML editor
No pixilation when you resize
Supports event handlers
Can animate with JavaScript
Not yet in Inkscape

Text Boxes in Inkscape
Create simple text box
Set font
Type
Add arrows as necessary

Why Use OSS for User Assistance?
Accessible to everyone
Open standards
Price is right
Learning curve comparable from app to app
Portability

Resources
OpenOffice.org: http://www.openoffice.org
OOo Doc Team: http://oooauthors.org
Scribus: http://www.scribus.net
Lyx: http://www.lyx.org
The GIMP: http://www.gimp.org
Inkscape: http://www.inkscape.org

Other Resources
TheOpenDisc: http://www.theopendisc.com
Wikipedia list of OSS packages: http://en.wikipedia.org/wiki/List_of_open_source_ software_packages
PDF Creator: http://www-pdfcreator.com/
Dia flowchart tool: http://live.gnome.org/Dia/
Mike McCallister: http://www.michaelmccallister.com

Open Source Tools for User Assistance

by Michael McCallister on Apr 09, 2009

Accessibility

Categories

Tags

Upload Details

Usage Rights

1 Embed 4

Statistics

Open Source Tools for User Assistance — Presentation Transcript