Title suggestions for topics?

This forum is for all Flare issues not related to any of the other categories.
Post Reply
General Confusion
Propeller Head
Posts: 28
Joined: Thu Jul 12, 2007 12:20 pm
Location: Bath MI

Title suggestions for topics?

Post by General Confusion »

Greetings, all, and happy Friday! :D

Throughout our manuals, I have a “concept” topic that provides detail on the settings available in a particular screen or task, then I have “task” topics that show the user how to accomplish what they want in a concise manner, without all the fluff. On the task topics, I have a link back to the concept topic: “Consider reviewing Quick View:[name] before proceeding with the instructions in this topic.”

For a working title, I’ve been calling the concept topics “Quick View: [screen or task name]”. I don’t like “Quick View” – often, there’s nothing “quick” about it, as there may be much detail. I want to stick with a uniform name, however, so that it stands out in the TOC.

I’ve thought of going with “Understanding [screen or task]”, but figured it was time to check with the pros. Any suggestions?
LTinker68
Master Propellus Maximus
Posts: 7247
Joined: Thu Feb 16, 2006 9:38 pm

Re: Title suggestions for topics?

Post by LTinker68 »

If it's an overview type of topic then I might go with "About [screen or task name]".
Image

Lisa
Eagles may soar, but weasels aren't sucked into jet engines.
Warning! Loose nut behind the keyboard.
KevinDAmery
Propellus Maximus
Posts: 1985
Joined: Tue Jan 23, 2007 8:18 am
Location: Darn, I knew I was around here somewhere...

Re: Title suggestions for topics?

Post by KevinDAmery »

"About" works, but I also think "Understanding" would work too.
Until next time....
Image
Kevin Amery
Certified MAD for Flare
General Confusion
Propeller Head
Posts: 28
Joined: Thu Jul 12, 2007 12:20 pm
Location: Bath MI

Re: Title suggestions for topics?

Post by General Confusion »

Looks like I may be in for a coin-toss... :)

Thank you both! Enjoy the weekend.
forfear
Propellus Maximus
Posts: 766
Joined: Sat Feb 16, 2008 3:37 am
Location: Jungle Jingles

Re: Title suggestions for topics?

Post by forfear »

I first learned all I needed to know about tech writing by reading and emulating Flare's help. :lol:

i think they use About [widget x]
for concept topics. that's what i try to use mostly as well.
If you submit your bug feedback request here, the more likely it'll get fixed or included in a future release
Open Utilities PageLayout Resizer for Flare/Blaze | Batch builder
General Confusion
Propeller Head
Posts: 28
Joined: Thu Jul 12, 2007 12:20 pm
Location: Bath MI

Re: Title suggestions for topics?

Post by General Confusion »

I liked "About", too, but got outvoted. Whatever; there are worse tragedies, right? :wink:

Thank you to all for your input; much appreciated!
Post Reply