Topic structure & combining topics into end-to-end scenarios

This forum is for all Flare issues related to the HTML5, WebHelp, WebHelp Plus, and Adobe Air Targets
Post Reply
simona
Propeller Head
Posts: 56
Joined: Wed Feb 27, 2013 3:16 am
Location: Bremen, Germany

Topic structure & combining topics into end-to-end scenarios

Post by simona »

We are noobs, implementing Flare 9 and currently discussing our topic structure.

What we want to do is use task, concept and reference as topic types, but we are having some problems deciding about the granularity and total number of our tasks. Our previous end user documentation was rather verbose and unstructured, so we can reuse little of that. Also, thinking in terms of tasks our users perform, instead of dialogues and functions, doesn't come easy to many of us.

Luckily, DEV is also slowly shifting to use-case-based documentation and QM has some nicely structured test cases we can work with, but this entire process of task definition has proved to be more time-consuming than originally expected. Guesstimations currently run from 300 to 800 tasks in total for launch, which shows how very much at the beginning of things we are right now.

Additionally, when our tasks are defined and documented, we want to be able to combine them into end-to-end scenarios as well. Has this been done before using Flare (apart from the Flare WebHelp itself)? If so, how? Do we simply create a new topic, "workflow A", which then contains, say, 50 tasks? How can this best be done in Flare, so that I only have to update the tasks themselves?

Oh, our output is web-based (WebHelp, HTML 5), plus PDFs if users want to print topics. We'll likely end up having 2 projects (German/English) and we are documenting 1 single, but rather complex SW product.

Any pointers in the right direction or links to best practice procedures described somewhere on the web will be much appreciated. I'm probably not the only one with such problems and as the only tech writer on this project I really, really could use some motivational input from you guys :?
Flare 2023 r3, Capture 7
TechWriter with 10+ years Flare experience (software)
99% remote
Robotman
Sr. Propeller Head
Posts: 186
Joined: Sat Mar 04, 2006 3:05 am
Location: Melbourne, Australia
Contact:

Re: Topic structure & combining topics into end-to-end scenarios

Post by Robotman »

I will soon be in a similar position to this and am looking forward to some great responses. As a sole tech writer for software with far too much work to do and not enough time to do it in, your post is where I want the docs to go. Everybody understands where we need to be but unfortunately I'm not given the resources or time in which to put us in that position. That said, our coders are still using VB6 *shudders* :P
\m/ Gary \m/
Flare 2024
Screaming Symphony
simona
Propeller Head
Posts: 56
Joined: Wed Feb 27, 2013 3:16 am
Location: Bremen, Germany

Re: Topic structure & combining topics into end-to-end scenarios

Post by simona »

@Gary: I'm so glad you posted this, now I don't feel so lonely anymore :) What you describe is exactly the situation here, which is why we decided to go for more structured, topic-based authoring, hoping it will eventually reduce time & effort going into our end user documentation. Let's hope some of the Senior Propeller Heads find the time to post some responses here!

Also, could anyone provide more input on how long the initial topic/task definition for previously unstructured documentation usually takes? I keep reading and hearing that this conceptional phase is the most important one, may take rather long, but will help save time later on in the project - still I haven't been able to find concrete numbers to back this up. If you have been there and done that, I'd be happy to hear about your experience with this. Thanks in advance!
Flare 2023 r3, Capture 7
TechWriter with 10+ years Flare experience (software)
99% remote
simona
Propeller Head
Posts: 56
Joined: Wed Feb 27, 2013 3:16 am
Location: Bremen, Germany

Re: Topic structure & combining topics into end-to-end scenarios

Post by simona »

Just to show that I'm not idling about and waiting for responses here, I have found this blogpost:

https://kaiweber.wordpress.com/2011/11/ ... to-topics/

which linked to this blogpost:

http://kaiweber.wordpress.com/2011/08/1 ... mentation/

which makes me believe that we will probably continue our topic-definition process with a suitable set of pilot topics, ideally 1 big workflow.

That should help to validate our structure and identify the suitable Flare features. What it will not do, however, is help us to identify our total number of topics, which, of couese, would come in handy to evaluate project duration (which, coincidentally, happens to be the one thing everyone here desperately wants to know). But one step after the other, I guess.
Flare 2023 r3, Capture 7
TechWriter with 10+ years Flare experience (software)
99% remote
Post Reply