How to have a better day at work PRESENTED BY Daniel Ferguson TIP - - PowerPoint PPT Presentation

how to have a better day at work
SMART_READER_LITE
LIVE PREVIEW

How to have a better day at work PRESENTED BY Daniel Ferguson TIP - - PowerPoint PPT Presentation

How to have a better day at work PRESENTED BY Daniel Ferguson TIP #1: DISABLE AUTO-RELOAD File > Options > General > Auto-Reload Documents TIP #2: GRASP THE POWER OF Yet! TIP #3: ASK TWO SIMPLE QUESTIONS EVERY DAY What went well


slide-1
SLIDE 1 PRESENTED BY

How to have a better day at work

Daniel Ferguson

slide-2
SLIDE 2
slide-3
SLIDE 3

File > Options > General > Auto-Reload Documents

TIP #1: DISABLE AUTO-RELOAD

slide-4
SLIDE 4

Yet!

TIP #2: GRASP THE POWER OF

slide-5
SLIDE 5
  • What went well for me today?
  • What’s going to go well for me tomorrow?

TIP #3: ASK TWO SIMPLE QUESTIONS EVERY DAY

slide-6
SLIDE 6 PRESENTED BY

No Glossary Tab? No Problem

Neil Perlin

slide-7
SLIDE 7
slide-8
SLIDE 8
slide-9
SLIDE 9
slide-10
SLIDE 10
slide-11
SLIDE 11

HYPERLINKS

slide-12
SLIDE 12
slide-13
SLIDE 13
slide-14
SLIDE 14
slide-15
SLIDE 15
slide-16
SLIDE 16
slide-17
SLIDE 17
slide-18
SLIDE 18
slide-19
SLIDE 19
slide-20
SLIDE 20
slide-21
SLIDE 21
slide-22
SLIDE 22
slide-23
SLIDE 23
slide-24
SLIDE 24
slide-25
SLIDE 25

Thank you... Questions Later

978-657-5464 | nperlin@nperlin.cnc.net www.hyperword.com | Twitter: NeilEric

slide-26
SLIDE 26 PRESENTED BY

Improving Search: Quick Fix Tips

Denise Kadilak, Blackbaud Inc.

slide-27
SLIDE 27
  • Click the Search.html link to view search term used

RETURNED TO OUR FEEDBACK SERVICE

slide-28
SLIDE 28
  • Search term used displays

SEARCH TERM

slide-29
SLIDE 29

ADD A DIRECTIONAL SYNONYM

slide-30
SLIDE 30

IMPROVED SEARCH RESULTS

slide-31
SLIDE 31

YOU CAN ALSO CREATE SYNONYM GROUPS!

slide-32
SLIDE 32
  • 1. From Project Organizer in Flare, right-click on the

Advanced folder.

  • 2. Select Add Synonym File.
  • 3. From the Add file screen, select New from template,

give it a File name, and click Add.

  • 4. The Synonym editor appears, and you can start adding

your words or group of words.

ADD SYNONYMS TO FLARE PROJECT

slide-33
SLIDE 33
  • After you create synonyms in Flare they are automatically

applied at the project level.

  • All targets incorporate them when you generate and

publish new Flare output.

  • Merged project synonym files remain separate - for

example, if you create synonyms in project A but not in project B, only the topics from project A use the synonyms when users perform searches in the output.

ADD SYNONYMS TO FLARE PROJECT

slide-34
SLIDE 34
  • The synonym file can only use a single word to improve

your search results

  • However, if you create an Auto-index file you can select a

phrase to point to an index term, allowing the search to include the phrase in the search process.

ADD PHASES TO SEARCH

slide-35
SLIDE 35
  • ADD PHASES TO SEARCH
slide-36
SLIDE 36
  • 1. Under the Project Organizer, right-click on the

Advanced folder.

  • 2. Select Add Auto-index Phrase Set, and create a file.
  • 3. You can then create a new phrase set and point it to an

index term.

ADD PHASES TO SEARCH

slide-37
SLIDE 37

Looks like this:

MADCAP SEARCH – OUT OF THE BOX

slide-38
SLIDE 38

Looks like this:

MADCAP SEARCH – OUT OF THE BOX

slide-39
SLIDE 39
  • Add a Sitemap – helps with search engine
  • ptimization(SEO), making it easier for search indexing

services to find your output, improving results.

– Sample: https://www.blackbaud.com/files/support/howto/coveo/fenxt/

MADCAP SEARCH – EDITS TO CONSIDER

slide-40
SLIDE 40
  • Search Guide - PDF
  • Customize results page – blog post
  • About search – online help
  • denise.kadilak@Blackbaud.com – my email

RESOURCES

slide-41
SLIDE 41 PRESENTED BY

Lightning Talk: Syntax Snippets

Chelsea Santos

slide-42
SLIDE 42
  • Leverage Flare features to improve training
  • Round up and consolidate examples from our guides

– Replace whole-guide examples – Supplement Acrolinx and Documentation Bible

  • Provide a template written to current standards

– Cover common examples and use cases – Single source of truth for “how to write it”

GOALS

slide-43
SLIDE 43
  • Templates with preset styles, conditions, and text
  • Inline instructions for additional guidance
  • In-project help
  • Content that is:

– Recent – Usability-tested – Reflects where the technology is going

WHAT ARE SYNTAX SNIPPETS?

slide-44
SLIDE 44
  • Functionally the same

– Both are *.flsnp files

  • “Regular” snippets

– Reside in Resources | Snippets – Are used as is

  • Syntax snippets

– Reside in a Templates folder – Are customized

SNIPPETS VS. SYNTAX SNIPPETS

slide-45
SLIDE 45
  • Authored in a master repository
  • Accessed in child repositories
  • Syntax folder contains four subfolders
  • File names start with keywords

– AirDry.flsnp – Reagents_dilute.flsnp – Options_pick-one.flsnp – Options_pick-any.flsnp

EASY ACCESS

slide-46
SLIDE 46

PROMOTING GOOD WRITING

Consistency

  • Promotes learning
  • Sets expectations
  • Reduces ambiguity
  • Promotes safe

product use

  • Is professional

Training

  • Closes knowledge

gaps

  • Efficient (no looking up
  • r maintaining

examples)

Values

“We are relentless in the creation of great products”

slide-47
SLIDE 47

HOW TO USE SYNTAX SNIPPETS

Find Your Snippet Drag to Topic Convert to Text Modify as Needed

Step 1 Step 2 Step 3 Step 4

slide-48
SLIDE 48

Examples

slide-49
SLIDE 49

NOTHING BUT CONTENT

Self-evident snippets like this one do not have instructional text or options

slide-50
SLIDE 50

MULTIPLE OPTIONS IN ONE SNIPPET

Comments explain each option Divs group

  • ptions
slide-51
SLIDE 51

INLINE INSTRUCTION

Comments provide

  • instruction. In this

case, how to organize your consumable list.

slide-52
SLIDE 52

INTRODUCTORY INSTRUCTION

This snippet shows how to write and style default software settings

slide-53
SLIDE 53

FURTHER READING

Comments direct you to examples for less common, more complicated programs This snippet has two preformatted thermal cycler programs

slide-54
SLIDE 54

Thank You!

Chelsea Santos, Content Architect, csantos2@illumina.com

slide-55
SLIDE 55 PRESENTED BY

Answer Keys for Printed Training Manuals

Sandra Wheeler

slide-56
SLIDE 56
  • Printed training manuals for a live class.
  • Student and Instructor versions share content within the

same project file.

  • Student book shows blanks, allowing students to write in

their answers.

  • Instructor book shows all answers throughout the book.
  • Both books must include an answer key with all answers.

THE SITUATION

slide-57
SLIDE 57
  • The answer key should auto-populate with changes from

activities and tests, to minimize maintenance.

  • If answers are conditioned out for students, they also

disappear in the answer key.

THE CHALLENGE

slide-58
SLIDE 58

CREATING THE ANSWER KEY

Table (bottom line only) “Answer” style “Question” style
slide-59
SLIDE 59

ADD ACTIVITIES TO ANSWER KEY

Copy activity from chapter. Paste into answer key. This maintains the table layout.
slide-60
SLIDE 60

LINK ACTIVITY NAME AND PAGE

Select activity title. Use cross-reference style to display heading and page number as plain text.
slide-61
SLIDE 61

LINK QUESTIONS

Select the question. Use cross-reference style to display question as plain text.
slide-62
SLIDE 62

LINK ANSWERS

Select the answer. Use cross-reference style to display answer as plain text, colored to stand out.
slide-63
SLIDE 63

INSTRUCTOR V. STUDENT BOOKS

slide-64
SLIDE 64
  • Cross references

– Questions and answers are updated in the chapter and automatically repopulated in the key.

  • Styles

– The Answer style is changed to appear white for students and blue for instructors. It is always present for cross references.

SOLUTION

slide-65
SLIDE 65 PRESENTED BY

Zero to 22 Translations

Entering the World of Translated Service Documents

Sandra Wheeler and Trish Edwards

slide-66
SLIDE 66

Challenges

  • Tight timeline
  • No template
  • No established LSP

relationships Requirements

  • 22 languages
  • Illustrated steps
  • Limited page count
  • Limited word count

The Project

slide-67
SLIDE 67

To maximize page usage:

  • 1. Arrange the illustrated steps in a two-column table.
  • 2. Follow the illustrated steps with translated content in a

two-column layout.

The Approach

slide-68
SLIDE 68

Page layouts

  • Single-frame layout

for illustrated steps

  • Hybrid layout for

transition

  • Two-column layout

for translations

slide-69
SLIDE 69

Single-frame page layout

slide-70
SLIDE 70

Hybrid page layout

slide-71
SLIDE 71

Two-column page layout

slide-72
SLIDE 72

TOC Magic

Apply the single-frame layout to the first page.

slide-73
SLIDE 73

Apply a hybrid layout to the transition page. Translations flow into the bottom two-column frame.

slide-74
SLIDE 74

Languages continue to flow into the two-column layout after the transition page.

slide-75
SLIDE 75

Flare’s innate feature set provided everything we needed to:

  • Quickly design a new template
  • Meet project requirements
  • Prepare for future translation projects

Summary