Main
Index 		Search
Posts 		Who's
Online 		Log
In

Home: Products: Off Topic / Other:
Software Manual - How do you want it

 
 


Dave
Staff / Moderator


Jul 23, 2002, 10:00 AM

Post #1 of 12 (9113 views)
Shortcut
     Software Manual - How do you want it  
For our next major release, we're looking at redoing the layout of the software manuals. What would you like to see most? Online HTML? Downloadable? PDF? Spiral bound printed copy for $10 more and mailed to you? Included in price?

Let me know what kind of manuals you'd like and what would be easiest for you. Also, if you have any thoughts on the current docs feel free to share those as well.

Dave Edis - Senior Developer
interactivetools.com
 


cdunivan
New User

Jul 24, 2002, 11:21 AM

Post #2 of 12 (9092 views)
Shortcut
     Re: [Dave] Software Manual - How do you want it [In reply to]  
I think PDF is by far the best way to go. I can save the Administrator's Manual and the Installation Guide, or print them if I need a hard copy, and I can send the Users' Guide to all the writers and editors for the site. If a revised copy is published, you can notify the licensees by e-mail to download it.

Chris Dunivan


isac
User

Jul 24, 2002, 4:13 PM

Post #3 of 12 (9081 views)
Shortcut
     Re: [Dave] Software Manual - How do you want it [In reply to]  
All formats are welcome


(This post was edited by isac on Jul 24, 2002, 4:14 PM)


osluk
User

Jul 27, 2002, 11:10 AM

Post #4 of 12 (9063 views)
Shortcut
     Re: [Dave] Software Manual - How do you want it [In reply to]  
Online for convenience and PDF for printing is what we use. If the unbranded thing is to be taken to its natural conclusion core pdf files could be included in a manual for the customers / clients of resellers.

We have a bit on general image manipulation and various bits that relate to the users dialup or connection and maybe file and data structure present in the organisation.

Many aspects are common to all products. We then have a mix and match process to create the perfect user manual for the particular client.
_______________________
Chris from Optima 
"please always add logical keywords to help find items"

[url "http://www.osl.net "]Optima Solutions Limited[/url]
http://www.osl.net
"technology for business" 
Nominet member for .UK names and European hosting




MalaK_3araby
User

Jul 27, 2002, 1:37 PM

Post #5 of 12 (9062 views)
Shortcut
     Re: [Dave] Software Manual - How do you want it [In reply to]  
Hi there.

PDF is great, but its not enough.

Included/Downloadable HTML is needed since it could be translated to other languages.

I Also enourage you to ask members to provide thier translations and provide it as downloadable files in a Member's Area.

HTML should be available and that can always be easily updates and converted to PDF .. i belive tools to do that are available on the net.

G-Luck.

--------------
Sure you can spell it, but do you get it?


chris nz
User

Aug 2, 2002, 1:36 AM

Post #6 of 12 (9046 views)
Shortcut
     Re: [Dave] Software Manual - How do you want it [In reply to]  
Online and PDF are the only ones really used here.

Thanks...:)


terrill
User

Aug 12, 2002, 12:14 PM

Post #7 of 12 (8953 views)
Shortcut
     Re: [Dave] Software Manual - How do you want it [In reply to]  
If you do PDF, please leave them unlocked so users can add their own notes. Think of the PDF as a Textbook in school: wouldn't you have just hated it if you couldn't add your own scribbles in the gutters? Especially during an "Open Book" test! <G>

One example that comes to mind is "The Complete Oracle." Great book. PDF sure is easier to lug through an Airport than the thick Dead-Tree Version. Too bad I can't put my notes in the PDF!

-- Terrill --
[quote]

"Evaporating expectations of quality:

1980's paradigm: If it's worth implementing once, it's worth implementing twice.
1990's paradigm: Ship the prototype!
2000's paradigm: Ship the idea!"

   ---Larry Rosler:
   http://www.perl.com/pub/a/2000/06/rosler.html

[/quote]


MAGSGQ
User

Aug 18, 2002, 4:12 PM

Post #8 of 12 (8848 views)
Shortcut
     Re: [terrill] Software Manual - How do you want it [In reply to]  
Hard cover. I have always loved to have a manual on my bookcase or in my credenza for easy access....especially seeing how I have to have too many windows going at once.


joa1
User

Aug 21, 2002, 6:32 PM

Post #9 of 12 (8828 views)
Shortcut
     Re: [Dave] Software Manual - How do you want it [In reply to]  
Hi Dave,

Printed manuals are my preference, *but* with a PDF online, that is updated regularly when needed... And keep the HTML version on the website also. If I am working from another loccation and just need to peek quickly at the manual, both printed and PDF will be by my PC on my desk, and I don't want to download a new PDF just for a quick look at something.

Even if you do not sell the hardcopy, the PDF can always be printed and bound and allows for quick updates of the hardcopy - it would be nice if udates are referenced (pages xyz were changed... Easy tracking and replacement of hardcopy individual pages would be quick.)

Thanks!

Joao


Moira
New User

Oct 18, 2002, 7:28 PM

Post #10 of 12 (8315 views)
Shortcut
     Re: [Dave] Software Manual - How do you want it [In reply to]  
I prefer online and/or PDF. It isn't cost efficient to print hardcopy manuals in my opinion



Moira



Teambldr
User

Oct 19, 2002, 5:33 AM

Post #11 of 12 (8305 views)
Shortcut
     Re: [Dave] Software Manual - How do you want it [In reply to]  
Hi Dave,

My idea is a bit of a hybrid version.

Use online for helpfiles that are updated with each version change. Offer PDF for printing and online for the most up to date reference.

Offer a printed version and a hardcopy of the software together for 15.00 including s and h. (same as Macromedia charges)

Offer an unbranded userside version that is downloadable (html not PDF due to it being integrated within the install and to allow personalization by the site owner.

Just a thought!Cool
Brian


Dave
Staff / Moderator


Oct 21, 2002, 10:12 AM

Post #12 of 12 (8288 views)
Shortcut
     Re: [Dave] Software Manual - How do you want it [In reply to]  
Thanks everybody for your feedback on this topic!

For the next major manual revisions we've decide to go with HTML and PDF.

I'm going to lock this thread, but if you want to talk more about the manual, please feel free to start a new thread.

Dave Edis - Senior Developer
interactivetools.com