Why Flare Why Now 2010 Draft14 - STC Rochester€¦ · Flare users • Award‐winning independent technical communicator, author, and publisher • On MadCap’s list of recommended

Why Flare, Why Now? Or, It’s Time to Don Your Propeller Beanies!

March 13, 2012

© 2012 Nita Beck and Lorraine Kupka 1

Why Flare, Why Now?Or,It’sTimetoDonYourPropellerBeanies!Not a sales pitch, but an unabashedly passionate testimonial

Who Nita Beck is• Member of Rochester STC almost 31 years• Award‐winning independent technical communicator, content strategist, and Flare instructor

• On MadCap’s list of recommended Flare consultants• Certified “MAD” (MadCap Advanced Developer) in Flare• Manager and founding member of the Rochester Flare User Group

3/12

/201

2Why Flare, W

hy Now

?

2


March 13, 2012


Who Lorraine Kupka is• Author of Five Steps to MadCap Flare, a book for new Flare users

• Award‐winning independent technical communicator, author, and publisher

• On MadCap’s list of recommended Flare consultants• Contributor to and founding member of the Rochester Flare User Group

• Certified “MAD” (MadCap Advanced Developer) in Flare

3/12

/201

2Why Flare, W

hy Now

?

3

Who we’re notMadCap employeesRecipients of free Flare licenses and

technical supportSubstitutes for MadCap technical support

3/12

/201

2Why Flare, W

hy Now

?

4


March 13, 2012


What you’re in for• Answers to Flare FAQs:

• “I’ve heard it talked about for years, but what is it?”• “It only produces Help systems, right? But I write policy manuals, so…”

• “Will we need to change our publication processes much?”

• “What’s the workflow like?”• “What about reviews of drafts?”• “Can we reuse our existing documentation?”• “Where can I get training?”• “How do I convince my boss we need Flare? – And sooner rather than later?”

3/12

/201

2Why Flare, W

hy Now

?

5

WHAT IS FLARE?A Windows application that…Manages individual topics… and images… and snippets… and page layouts… and master pages… and style sheets… and many more source files…Separates content from format…Is based on XML, XHTML, and CSS…Builds one or more outputs: PDFs, XPS, eBooks, Help systems of many flavors, knowledge bases, and…

3/12

/201

2Why Flare, W

hy Now

?

6


March 13, 2012


A Windows application that…

3/12

/201

2Why Flare, W

hy Now

?

7

Manages individual topics…3/12

/201

2Why Flare, W

hy Now

?

8


March 13, 2012


and images…

3/12

/201

2Why Flare, W

hy Now

?

9

and snippets…3/12

/201

2Why Flare, W

hy Now

?

10


March 13, 2012


and page layouts…

3/12

/201

2Why Flare, W

hy Now

?

11

and master pages…3/12

/201

2Why Flare, W

hy Now

?

12


March 13, 2012


and style sheets…

3/12

/201

2Why Flare, W

hy Now

?

13

and many more source files• Conditional tag sets• Variable sets• Import files• Alias files• Skin files• …• …• …• And more!

3/12

/201

2Why Flare, W

hy Now

?

14


March 13, 2012


Separates content from format…

Formatted Content

Layout (.flpgl, .flmpg)

Styles (.css)

Topics (.htm) 3/

12/201

2Why Flare, W

hy Now

?

15

Topic with tags showing3/12

/201

2Why Flare, W

hy Now

?

16


March 13, 2012


Is based on XML, XHTML, and CSS

3/12

/201

2Why Flare, W

hy Now

?

17

Builds one or more outputsSource Files and Processing Rules*

• Topics• Images• Snippets• Style sheets• Conditions• Variables• Skins• …

Output File(s)

• PDF, XPS• ePUB• WebHelp, WebHelp Plus, and WebHelp AIR

• HTML5 Help (aka WebHelp 2.0)• .CHM Help• Word, FrameMaker• …

3/12

/201

2Why Flare, W

hy Now

?

18

*Contained in a target file


March 13, 2012


PDF, XPS• Software manuals• Hardware manuals

• Training guides

• Style guides• Policy guides• Specifications• Plans• Reports• …

3/12

/201

2Why Flare, W

hy Now

?

19

eBooks• Software manuals• Hardware manuals• Training guides

• Style guides

• Textbooks• Reference guides

• …

3/12

/201

2Why Flare, W

hy Now

?

20


March 13, 2012


WebHelp Mobile• Deployed on the web• Optimized for smart phones

3/12

/201

2Why Flare, W

hy Now

?

21

WebHelp• Deployed on the web or locally• Browser‐independent

3/12

/201

2Why Flare, W

hy Now

?

22


March 13, 2012


HTML5 Help• Deployed on the web or locally• Simplified user interface*• Frameless

3/12

/201

2Why Flare, W

hy Now

?

23

*Compared to WebHelp

HTML5 Help (continued)• Offers “Google‐like” context for search results

3/12

/201

2Why Flare, W

hy Now

?

24


March 13, 2012


CHM (aka HTML) Help• Microsoft’s aged compiled (single‐file) format• Locally installed only

3/12

/201

2Why Flare, W

hy Now

?

25

Knowledge bases3/12

/201

2Why Flare, W

hy Now

?

26


March 13, 2012


Other outputs• FrameMaker files, Word files, DITA, XHTML

3/12

/201

2Why Flare, W

hy Now

?

27

THE WORKFLOWA little bit different, A little bit the same…

3/12

/201

2Why Flare, W

hy Now

?

28


March 13, 2012


The workflow1. Get yourself and/or your team organized2. Commit yourself to documenting your work3. Plan for conversion of legacy content

• What to keep, what to abandon4. Convert your legacy content5. Adapt imported content for single‐sourcing6. Invent new content

3/12

/201

2Why Flare, W

hy Now

?

29

The workflow7. Set up new targets8. Expect an iterative authoring process9. Devise a workable review process10. Practice good troubleshooting and debugging

habits11. Practice good backup / archiving habits

3/12

/201

2Why Flare, W

hy Now

?

30


March 13, 2012


PLUS SIDE, MINUS SIDE, ALL SIDESWhy use Flare?The challenges of using FlareHow to learn to use FlareHow to convince your boss to get you Flare

3/12

/201

2Why Flare, W

hy Now

?

31

Why use Flare?1. Industry trends, best practices2. Emerging formats3. Cost savings4. Affordability5. Speed to market6. Customization‐friendly

3/12

/201

2Why Flare, W

hy Now

?

32


March 13, 2012


But wait, there’s more…7. Leading edge8. Flexible and feature rich9. Enhanced authorial control10. Content management system11. Team authoring12. Source control

3/12

/201

2Why Flare, W

hy Now

?

33

And more…13. Localization‐friendly14. MadCap’s commitment to customers, users15. Major updates annually16. Dissatisfaction with other tools, vendors17. The Passion Quotient*

• Sarah O’Keefe, Scriptorium Publishing, at http://www.scriptorium.com/2011/12/the‐passion‐quotient/

3/12

/201

2Why Flare, W

hy Now

?

34


March 13, 2012


The challenges of using Flare1. Loss of authorial control over format2. Can have a steep learning curve3. Very different from “desktop publishing”4. Demands knowledge of CSS5. Demands new processes (development,

review, maintenance)6. Learning to write non‐linearly and out of

context7. Giving up / letting go of old habits

3/12

/201

2Why Flare, W

hy Now

?

35

And more challenges9. Flare is still maturing, comparatively speaking10. Performance issues when working across a

network11. Print targets are not trivial to set up12. Doesn’t handle Word output as well as PDF

output13. Some users think it’s mouse‐heavy, not

keyboard‐friendly, therefore slow to use14. Perception that MadCap focuses on new

features to the detriment of bug fixes

3/12

/201

2Why Flare, W

hy Now

?

36


March 13, 2012


Learning to use Flare1. Fully‐functional, 30‐day trial version2. Flare’s comprehensive Help system and

many printable documents3. Video tutorials and webinars

• Available on MadCap’s web site

4. MadCamp training• At MadCap’s offices in California• Various other locations in North America, Europe• Online

5. MadCap Roadshow• Various locations – including Rochester on March 16!

3/12

/201

2Why Flare, W

hy Now

?

37

Learning to use Flare6. MadCap‐hosted peer‐to‐peer user forums7. Independent Flare user groups8. Third‐party books and blogs

• Lorraine’s book: http://www.northcoastwriters.com/fiddleheadpubs/

• Others: http://www.madcapsoftware.com/training/books.aspx

9. w3schools• Offers tutorials on CSS, XML, HTML• http://www.w3schools.com/

3/12

/201

2Why Flare, W

hy Now

?

38


March 13, 2012


Convincing your boss to get you Flare1. Make a business case2. Use the vast amount of information at MadCap’s

web site• Feature lists• Testimonials• Case studies (including discussion of cost savings)• Descriptions of support contracts

3. Contact a MadCap sales rep• Our area rep Mike Mancuso is originally from Fairport and would be happy to discuss ideas for making a case

3/12

/201

2Why Flare, W

hy Now

?

39

Q&A

3/12

/201

2Why Flare, W

hy Now

?

40

Documents

Why Flare Why Now 2010 Draft14 - STC Rochester€¦ · Flare users • Award‐winning independent technical communicator, author, and publisher • On MadCap’s list of recommended