Dev Shed Lounge
 
Forums: » Register « |  User CP |  Games |  Calendar |  Members |  FAQs |  Sitemap |  Support | 
User Name:
Password:
Remember me
Go Back   Dev Shed ForumsOtherDev Shed Lounge

Reply
Add This Thread To:
  Del.icio.us   Digg   Google   Spurl   Blink   Furl   Simpy   Y! MyWeb 
Thread Tools Search this Thread Rate Thread Display Modes
 
Unread Dev Shed Forums Sponsor:
Stop making mediocre tutorials.The best tutorials are video! Camtasia Studio makes it easy to create engaging, buzz-building screen videos at any size, in any popular format. Download the free trial!
  #1  
Old October 14th, 2002, 12:08 AM
Alianto Alianto is offline
Contributing User
Dev Shed Newbie (0 - 499 posts)
 
Join Date: Oct 2002
Posts: 61 Alianto User rank is Just a Lowly Private (1 - 20 Reputation Level) 
Time spent in forums: 9 m 2 sec
Reputation Power: 6
User Manual / Documentation for my program.

Hi there,

I am not sure if this is the right place to post this message, but, well, I hope it's alrigjt.

Anyway, I am working on a project (on-line booking system), and I'd like to write a good documentation for my users to use it (both admin and normal users).

I have seached zillions of webpages, but I still can't find a good website which explains how to write good documentation.

Any help willl be appriciated,

Thanks,
Alianto

Reply With Quote
  #2  
Old October 14th, 2002, 12:26 AM
ghatzhat ghatzhat is offline
Contributing User
Dev Shed Newbie (0 - 499 posts)
 
Join Date: Jun 2002
Posts: 361 ghatzhat User rank is Just a Lowly Private (1 - 20 Reputation Level) 
Time spent in forums: 1 h 9 m 5 sec
Reputation Power: 7
in my opinion, documentation shouldn't be written according to strict rules. it should address the needs of the expected users.

for the admin manual, just sit down and think about questions like:

how do i install this system?
what's the db structure like?
where do i edit the list of <whatever>?
how do i do an effective backup/migration etc?

for the user manual, make it task based:

how do i add a user?
how do i get a report?

find someone who is unfamiliar with the system (and not a tech freak!), give them your draft manual and tell them to play... and see where they get lost... those will be the bits you need to clarify in your writing.

it all depends on what the system is trying to achieve. don't end up with a manual that is so detailed and precise that no-one will read it!
__________________
Little more than a playground for the bugs that live beneath us...

Reply With Quote
  #3  
Old October 14th, 2002, 01:05 AM
Alianto Alianto is offline
Contributing User
Dev Shed Newbie (0 - 499 posts)
 
Join Date: Oct 2002
Posts: 61 Alianto User rank is Just a Lowly Private (1 - 20 Reputation Level) 
Time spent in forums: 9 m 2 sec
Reputation Power: 6
Thanks my friend.

Cheers,
Ali

Reply With Quote
Reply

Viewing: Dev Shed ForumsOtherDev Shed Lounge > User Manual / Documentation for my program.


Thread Tools  Search this Thread 
Search this Thread:

Advanced Search
Display Modes  Rate This Thread 
Rate This Thread:


Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

vB code is On
Smilies are On
[IMG] code is On
HTML code is Off
View Your Warnings | New Posts | Latest News | Latest Threads | Shoutbox
Forum Jump


Forums: » Register « |  User CP |  Games |  Calendar |  Members |  FAQs |  Sitemap |  Support | 
  
 

IBM developerWorks




© 2003-2008 by Developer Shed. All rights reserved. DS Cluster 4 hosted by Hostway