Flare Transition Overview

8/11/2019 Flare Transition Overview

1/37

Sharon BurtonProduct Manager/Product Evangelist

MadCap [email protected]


2/37

I am

Sharon Burton

Product Manager/Product Evangelist for MadCapSoftware

Been in Tech Communication for almost 20years

Previous job as documentation manager at alarge company in Southern California

Managed 13 writers scattered all over the world

Managed a library of hundreds of manuals

FrameMaker and RoboHELP expert Teach Technical Communication to engineering

students at University of California, Riverside


3/37

Key members of the old RoboHelp

team formed MadCap Software Based in La Jolla, California

Were almost 4 years old

Who is MadCap Software?


4/37

Multimedia

LocalizingReporting

Authoring &Publishing

Our product line

ContentManagement

&Collaboration


5/37

Multimedia

LocalizationAdvancedSupport

Authoring

Software Solutions

A

U

T

H

O

R

&

P

U

BL

I

S

H

Online and print contentdevelopment and publishing

Print development for longprint documents

The XML-based Glossy Printsolution

For reviewers or the occasionalcontributor


6/37

Multimedia

LocalizationAdvancedSupport

Authoring

Software Solutions

M

UL

T

I

M

E

D

I

A

Capture anything that appears

on your screen

Add dynamic audio to youronline publishing

Easily create softwaresimulations and tutorials


7/37

Multimedia

Localizing

Reporting

Authoring

Software Solutions

LOCALIZING

Integrated translation andpublishing


8/37

Multimedia

Localizing

Reporting

Authoring

Software Solutions

RE

P

O

R

T

S

User feedback, reporting, andWeb 2.0 customer interaction

Scan, analyze, report, and fixerrors or problems


9/37

Multimedia

LocalizingReporting

Authoring &Publishing

TeamServer

Software Solutions

Team Server

Automate and manage yourcontent across the enterprise


10/37

Today, well see

Blaze

Flare

X-Edit Family

Lingo


11/37

Creating a Single-SourceAuthoring Environment

With RoboHelp

Mike HamiltonV.P. Product ManagementMadCap [email protected]


12/37

What is Blaze?

Flare 4:Complex printed and

online content

Blaze:Complexprintedcontent

Complexprintedcontent


13/37

What is Blaze?

Blaze is the perfect solution for complex

printed manuals If you onlydevelop content for printed

output, you need Blaze

For example, you write maintenance manuals

Flare 4 includes all the features of Blaze

If you develop content online help andprinted output, you need Flare 4

For example, you write documentation forsoftware products


14/37

MadCap Blaze

Printed documents

Topic-based content development

Faster content development

Content reuse with conditional text,

variables, snippets, outlinesAnd more

Flexibility with XML and CSS

Content is separate from formattingPrinted Page Layouts


15/37

MadCap Blaze

Easily create

Reference books

Hardware manuals

Illustrated guides

Maintenance manuals

And more


16/37


With RoboHelp



17/37


18/37


19/37


20/37

MadCap X-Edit Family

Improves your information workflow

Subject matter experts andoccasional contributors

Seamlessly review and provide content

for your documentation

No conversion headaches


21/37

X-Edit Contribute

Author creates templates in Flare 4 or Blaze

Save the templates Templates include text styles, and optionally,

images, table styles, variables, conditions, and soon

Email templates to your content contributors Using X-Edit Contribute, they create content in

the templates

Send the content back to you

Open and add to your Flare 4 or Blaze project No converting, fixing, and so on


22/37

X-Edit Review

In Flare 4 or Blaze, write a topic

Send it for review in Flare or Blaze Author decides if reviewers can edit or

annotate

Using X-Edit Review, reviewers open the

topic Make review comments, as author allowed

Reviewers email the topic back to author

Author opens it in Flare 4 or Blaze

Author decides to accept the entire topic Or just make the suggested changes


23/37


With RoboHelp



24/37

MadCap Lingo

Easily translate Flare or Blaze

components such asTable of contents

Topics

Index keywords

Concepts

Glossaries

Variables


25/37

MadCap Lingo

Reduce translation costs and time-

to-market

Easily translate MadCap Flare andBlaze content

Eliminate the need for out-of-projectfile transfers

Import and use TMX, Across, and a

few other TMs


26/37

Some concepts

Topic-based authoring

MadCap products are different

than most other tools This difference is important

You are more successful if you know

several concepts before you start


27/37

What is Topic-based Authoring?

Topic-based authoring focuses effort on the

topics your user needs to use the product Not the final deliverables

You dont develop an Admin book or a UsersGuide or a help

You develop a body of information thats helpful to theuser

Eventually, you decide how each piece of information isbest delivered to the user

Independent from the information development process

Maximize content reuse

h i i b d h i


28/37

Project


PrintingReports

UsingContainerObjects

SavingreportsCreating

Reports

AboutSchedules

AddingUsers

SettingPermissions

DeletingUsers

PlacingObjects

AboutObjects

AboutUsers

ExportingObjects

AboutContainment

Customizing

Objects

AboutProgramming

Objects andInheritance

EditingReports

ContainingObjects

RelatingObjects

ImportingReports

SettingSchedulesAbout

Reports

Wh i T i b d A h i ?


29/37

Project


Admin Guide

About Users

Adding Users

Deleting Users

Setting

PermissionsAbout Reports

CreatingReports

Editing Reports

Saving Reports

Printing Reports

ImportingReports

ProgrammersGuide

AboutProgramming

About Objects

Placing Objects

AboutContainment

Objects andInheritance

Using ContainerObjects

CustomizingObjects

RelatingObjects

Getting StartedHelp

About Users

About Reports

AboutProgramming

About ObjectsAboutContainment

ExportingObjects

About Schedules

Wh T i b d A th i ?


30/37

Why Topic-based Authoring?

Allows you to

Develop information based on the users informationneeds

Allow the users needs to determine how they get theinformation

Matches the Use Case or Scenario development

environment

Get your reviews done

Reviewing topics is easier than chapters

Your reviewers may actually reviewthetopics

Ad t t


31/37

Advantages to you

You will probably develop less information

But the quality of the information will behigher because its user centered

Significant content reuse

In the same project and between projects

Allows you to easily repurpose yourinformation

Cheaper to localize

Can go into localization sooner Send topics when they are done

T fi d t


32/37

To find out more

Information Development:

Managing YourDocumentation Projects,Portfolio, and Peopleby JoAnn T. Hackos

ISBN-10: 0471777110

ISBN-13: 978-0471777113

S h I t lki b t thi ?


33/37

So why am I talking about this?

This is the best way to develop

information in Flare or Blaze Other products, like FrameMaker, PageMaker,

or InDesign, for example, dont lendthemselves to this model

You develop a large pool of topics aboutyour product and your users informationneeds

Use Outlines to define the deliverables

Thesetopics are Admin Guide topics

Thosetopics are User Guide topics


34/37


With RoboHelp


Live demonstrations


35/37

Questions?


36/37

Thank you


37/37

Sharon BurtonProduct Manager/Product EvangelistMadCap [email protected]

[email protected]: madcapsoftware.wordpress.com

This slide show is available on my blog

Flare Transition Overview

Documents

Transcript of Flare Transition Overview