"For a quicker, more confident answer, consider consulting DITA Best Practices http://www.ibmpressbooks.com/bookstore/product.asp?isbn=0132480522
Even if you don't use DITA, this book is very clear and comprehensive about what goes into which…"
Technical Writing World
The social network for technical communicators
Daniel Berman's Discussions
Software Online Help
Started this discussion. Last reply by Kai Weber May 8. 11 Replies 0 Likes
Hi all,Interested in advice on creating a new Online Help for a Software product.Specifically, I was wondering on what structural outline to base this Help on.For example: Concepts, Tasks,…Continue
Receiving feedback on Online Help
Started this discussion. Last reply by Gordon Meyer Mar 10. 21 Replies 2 Likes
What direct method do you use to receive feedback from readers of your Online Help, if at all? How do you feel about embedded forms on the pages themselves as opposed to a link to a form or via…Continue
Current trends in documentation structuring
Started this discussion. Last reply by Daniel Berman Jan 29. 8 Replies 2 Likes
Hi all,My copmpany produces software tools for Web developers.Our existing documentation is immense and consists of highly-detailed Reference Manuals (User Guides) and Installation and Upgrade Guides…Continue
Daniel Berman's Page
Latest Activity
Daniel Berman replied to Daniel Berman's discussion Software Online Help"Sorry for not clarifying- delivered by the Web- WebHelp format, generated with Flare.
The above organization of the topics stems from the fact that I have a large amount of various types of information-some topics are general and explain features,…"
Richard S. replied to Daniel Berman's discussion Software Online Help"It sounds like you've adopted DITA in some way, and that you are trying to make your outline a hybrid that includes vestiges of the print world (ie XYZ Guide), and literal usages of DITA type names. Given that it's online, the…"
Daniel Berman replied to Daniel Berman's discussion Software Online Help"Well, our manuals are divided into a User Guide and an Installation Guide, the latter including all installation tasks.
We have concepts, we have tasks and we have a new UI that needs to be covered.
Just out of interest, what would you…"
Daniel Archer replied to Daniel Berman's discussion Software Online Help"I typically use this outline:
1. Introduction (subheads for things like system access / requirements, support desk info)
2. System Overview (concepts, navigation, workflows, unique terminology, iconography, help, spellcheck functionality, etc).
3.…"
Kai Weber replied to Daniel Berman's discussion Software Online Help"I'm not sure I follow you: The popular installation information ARE tasks, aren't they?
Your online help will probably have links, search and an interactive index, so the overall structure matters less than in a printed manual. Just make…"
Daniel Berman replied to Daniel Berman's discussion Software Online Help"Of course, each product is different.
For sure, suiting the outline to the customers is a great guideline, but when you know for a fact that the installation information is the most popular, where do you place all the rest(tasks, concepts, etc) and…"
Daniel Berman replied to Daniel Berman's discussion Software Online Help"What would you include in a Reference section?
"
hyna reza replied to Daniel Berman's discussion Software Online Help"Reference make the user's life more easy as references focus the specific group of users.So it would be able to help more users."
Kai Weber replied to Daniel Berman's discussion Software Online Help"Hi, Daniel, in my experience there is no "one size fits all" outline that is effective for all software products - and efficient to produce and maintain to boot.
As such, my best advice would be: Choose the outline that best suits your…"
hyna reza replied to Daniel Berman's discussion Software Online Help"Online help usually base on wiki.so go for it.Most convenient option for a software product online help
"
Daniel Berman posted a discussionSoftware Online Help
Hi all,Interested in advice on creating a new Online Help for a Software product.Specifically, I was wondering on what structural outline to base this Help on.For example: Concepts, Tasks, Reference, etc.Thanks,DanielSee More
Helen French commented on Daniel Berman's blog post Doc samples reference"http://www.madcapsoftware.com/products/flare/customerSamples.aspx
Not sure if this is the soft of thing you're looking for - samples of documentation produced using MadCap Flare. I've found it useful.
"
Kai Weber commented on Daniel Berman's blog post Doc samples reference"Hi, Daniel, I'm not aware of such a site. If I need samples, I usually search the web for companies or products I like (or competitors) and try to find their documentation.
That said, this page lists DITA samples by 22 organizations:…"
Daniel Berman posted a blog postDoc samples reference
Anyone know of a good reference site linking to Documentation samples? For example, samples of Online Help or samples of Getting Started guides? See More
Profile Information
- How did you hear about TWW?
- Searching the Web
Daniel Berman's Blog
Doc samples reference
Posted on March 28, 2012 at 2:39am 3 Comments 0 Likes
Anyone know of a good reference site linking to Documentation samples? For example, samples of Online Help or samples of Getting Started guides?
Comment Wall
- No comments yet!
© 2012 Created by Arnold Burian.
