Computing desk | ||
---|---|---|
< June 14 | << May | June | Jul >> | June 16 > |
Welcome to the Wikipedia Computing Reference Desk Archives |
---|
The page you are currently viewing is an archive page. While you can leave answers for any questions shown below, please ask new questions on one of the current reference desk pages. |
we are doing this project on writing documentation on the software that we had required for a particular business to use in order that it will improve its productivity but the problem is how do we go about writing the documentation,that is,could you help in giving me the skeleton or the outline of how a documentation is done. thankyou.
1) Intro (what does the software do, who makes it, etc.).
2) How to install the software.
3) Getting started (registering the software and preferences you need to set, etc.).
4) Basic instructions (how to do the most common tasks).
5) Advanced instructions (how to do more complicated tasks).
6) Customizing the software.
7) Solutions to common problems (error messages and possible solutions).
8) Contact us (support phone numbers, web sites, e-mails addresses, etc.).
9) Frequently asked questions ("Can I do X with this software ?" "No, that requires that you purchase the Y extension available at ...").
Be sure to include many high resolution screen shots to illustrate each step, especially when dealing with icons.
StuRat 23:32, 18 June 2007 (UTC)
I use what I call the "UPSOMUT" content model which ensures that documentation is complete. And it has always worked well for me.
1. 'U'nderstanding - the chapter that will provide an overview of the software.
2. 'P'lanning and 'S'etting up - the chapter that will provide information about minimum requirements along with pre-installation, installation, and post-installation tasks.
3. 'O'ptimizing - the chapter that will provide information about configuring various aspects of the software.
4. 'M'anaging or 'U'sing - the chapter that will provide information about how to manage or use the software.
5. 'T'roubleshooting - the chapter that will provide information about troubleshooting scenarios or error messages.
If the planning and managing aspects of the software call for you to provide comprehensive information, you can split up 2 and 4 to have seven chapters instead of five.
Zaksy 20:02, 20 June 2007 (UTC)
I'm trying to find out how to type letters with the overdot such as Ȧȧ Ḃḃ Ċċ Ḋḋ Ėė Ḟḟ Ġġ Ḣḣ İ Ṁṁ Ṅṅ Ȯȯ Ṗṗ Ṙṙ Ṡṡẛ Ṫṫ Ẇẇ Ẋẋ Ẏẏ Żż, without copy and pasting, perhaps with a keyboard shortcut or by adding a language, any help would be appreciated, thanks.
213.202.188.170 00:17, 15 June 2007 (UTC)
Can a version of G++ that runs under Linux compile programs to run console-mode in Windows? Neon Merlin 01:32, 15 June 2007 (UTC)
I've been tasked with trying to see what I can find out about protecting rating systems against gaming. So far, all I've found is [1] Any references to either attacks or defenses would be appreciated. Donald Hosek 17:35, 15 June 2007 (UTC)
How do I turn off that really annoying security feature of IE which refuses to let you go "BACK" to any page created with a form, without clicking "refresh" then "retry"? An answer which doesn't involve amending any other security features would be best. AndyJones 17:57, 15 June 2007 (UTC)
After I temporarily moved my graphics card to another computer and then put it back again, I got no more image on the monitor - it remains black. When I boot I hear a long beep (with a stutter), but the mb's manual doesn't say anything about those warning sounds. I assume the mb is broken. But before I buy a new one (and install and personalise all operating systems anew, which will probably take me a week), I thought I'd check if anyone can think of a different cause (I also have very limited internet access now). The graphics card itself still works - I tried it on another computer. Same for the monitor and the cable. I tried wiggling, cleaning the slot and 'looser fits', but nothing had any effect. The mb is a Gigabyte K8NS Pro and the card is a Matrox Marvel G400 TV (AGP). Any thoughts? DirkvdM 19:01, 15 June 2007 (UTC)
A new development: the computer remains completely dead now. I'll ask a separate question about this below. DirkvdM 10:07, 17 June 2007 (UTC)
Hi, I'm using Red Hat Fedora Core 3. Do clip drives work with this system? Are there any problems (eg. specific models that don't work properly) to watch out for? Cheers, The Mad Echidna 19:42, 15 June 2007 (UTC)
Thanks CesarB. I didn't know the term was in fact unconventional, and curiously hardly knew there even was a proper name for it (well sort of). If others are still reading this, I would still be interested if you have any definite confirmation on the USB Flash Drive issue. Regards, The Mad Echidna 22:10, 19 June 2007 (UTC)
Does over the air web (wi-fi, etc) scale up to many users like broadcast TV?
TV/Radio doesn't matter how many recipients get it yet they all get access to whatever is the power output of the signal. Why wouldn't "over the air" web like wi-fi and wi-max be the same. I realize that wired point to point access needs the source to scale up (or ration the signal) for more and more users.
Thanks - Denis 68.255.62.44 20:32, 15 June 2007 (UTC)
Got it - muchos gracias!
I'm in a bit of a quandry here. I want to give my sister a notebook as a gift, but here's the catch. I've only got about $600 to spare. I've found(potentially)the perfect thing. But it looks too good to be true. It's an Acer Aspire and it's got some pretty awesome specs for $500.
Are Acers reliable? Should I get this? I've read plenty of reviews and asked around, but can't make up my mind. Any suggestions?
Read this web site: https://addons.mozilla.org/en-US/firefox/addon/1662 And the users guide: http://www.abacom.com/~oraby/Weekedit/EN.html. Great, I've got it but can't find Wikudit to download (I've got Firefox 2.0.0.4. Can someone tell me where to find the download? Thanks, 70.233.130.68 23:37, 15 June 2007 (UTC)
Computing desk | ||
---|---|---|
< June 14 | << May | June | Jul >> | June 16 > |
Welcome to the Wikipedia Computing Reference Desk Archives |
---|
The page you are currently viewing is an archive page. While you can leave answers for any questions shown below, please ask new questions on one of the current reference desk pages. |
we are doing this project on writing documentation on the software that we had required for a particular business to use in order that it will improve its productivity but the problem is how do we go about writing the documentation,that is,could you help in giving me the skeleton or the outline of how a documentation is done. thankyou.
1) Intro (what does the software do, who makes it, etc.).
2) How to install the software.
3) Getting started (registering the software and preferences you need to set, etc.).
4) Basic instructions (how to do the most common tasks).
5) Advanced instructions (how to do more complicated tasks).
6) Customizing the software.
7) Solutions to common problems (error messages and possible solutions).
8) Contact us (support phone numbers, web sites, e-mails addresses, etc.).
9) Frequently asked questions ("Can I do X with this software ?" "No, that requires that you purchase the Y extension available at ...").
Be sure to include many high resolution screen shots to illustrate each step, especially when dealing with icons.
StuRat 23:32, 18 June 2007 (UTC)
I use what I call the "UPSOMUT" content model which ensures that documentation is complete. And it has always worked well for me.
1. 'U'nderstanding - the chapter that will provide an overview of the software.
2. 'P'lanning and 'S'etting up - the chapter that will provide information about minimum requirements along with pre-installation, installation, and post-installation tasks.
3. 'O'ptimizing - the chapter that will provide information about configuring various aspects of the software.
4. 'M'anaging or 'U'sing - the chapter that will provide information about how to manage or use the software.
5. 'T'roubleshooting - the chapter that will provide information about troubleshooting scenarios or error messages.
If the planning and managing aspects of the software call for you to provide comprehensive information, you can split up 2 and 4 to have seven chapters instead of five.
Zaksy 20:02, 20 June 2007 (UTC)
I'm trying to find out how to type letters with the overdot such as Ȧȧ Ḃḃ Ċċ Ḋḋ Ėė Ḟḟ Ġġ Ḣḣ İ Ṁṁ Ṅṅ Ȯȯ Ṗṗ Ṙṙ Ṡṡẛ Ṫṫ Ẇẇ Ẋẋ Ẏẏ Żż, without copy and pasting, perhaps with a keyboard shortcut or by adding a language, any help would be appreciated, thanks.
213.202.188.170 00:17, 15 June 2007 (UTC)
Can a version of G++ that runs under Linux compile programs to run console-mode in Windows? Neon Merlin 01:32, 15 June 2007 (UTC)
I've been tasked with trying to see what I can find out about protecting rating systems against gaming. So far, all I've found is [1] Any references to either attacks or defenses would be appreciated. Donald Hosek 17:35, 15 June 2007 (UTC)
How do I turn off that really annoying security feature of IE which refuses to let you go "BACK" to any page created with a form, without clicking "refresh" then "retry"? An answer which doesn't involve amending any other security features would be best. AndyJones 17:57, 15 June 2007 (UTC)
After I temporarily moved my graphics card to another computer and then put it back again, I got no more image on the monitor - it remains black. When I boot I hear a long beep (with a stutter), but the mb's manual doesn't say anything about those warning sounds. I assume the mb is broken. But before I buy a new one (and install and personalise all operating systems anew, which will probably take me a week), I thought I'd check if anyone can think of a different cause (I also have very limited internet access now). The graphics card itself still works - I tried it on another computer. Same for the monitor and the cable. I tried wiggling, cleaning the slot and 'looser fits', but nothing had any effect. The mb is a Gigabyte K8NS Pro and the card is a Matrox Marvel G400 TV (AGP). Any thoughts? DirkvdM 19:01, 15 June 2007 (UTC)
A new development: the computer remains completely dead now. I'll ask a separate question about this below. DirkvdM 10:07, 17 June 2007 (UTC)
Hi, I'm using Red Hat Fedora Core 3. Do clip drives work with this system? Are there any problems (eg. specific models that don't work properly) to watch out for? Cheers, The Mad Echidna 19:42, 15 June 2007 (UTC)
Thanks CesarB. I didn't know the term was in fact unconventional, and curiously hardly knew there even was a proper name for it (well sort of). If others are still reading this, I would still be interested if you have any definite confirmation on the USB Flash Drive issue. Regards, The Mad Echidna 22:10, 19 June 2007 (UTC)
Does over the air web (wi-fi, etc) scale up to many users like broadcast TV?
TV/Radio doesn't matter how many recipients get it yet they all get access to whatever is the power output of the signal. Why wouldn't "over the air" web like wi-fi and wi-max be the same. I realize that wired point to point access needs the source to scale up (or ration the signal) for more and more users.
Thanks - Denis 68.255.62.44 20:32, 15 June 2007 (UTC)
Got it - muchos gracias!
I'm in a bit of a quandry here. I want to give my sister a notebook as a gift, but here's the catch. I've only got about $600 to spare. I've found(potentially)the perfect thing. But it looks too good to be true. It's an Acer Aspire and it's got some pretty awesome specs for $500.
Are Acers reliable? Should I get this? I've read plenty of reviews and asked around, but can't make up my mind. Any suggestions?
Read this web site: https://addons.mozilla.org/en-US/firefox/addon/1662 And the users guide: http://www.abacom.com/~oraby/Weekedit/EN.html. Great, I've got it but can't find Wikudit to download (I've got Firefox 2.0.0.4. Can someone tell me where to find the download? Thanks, 70.233.130.68 23:37, 15 June 2007 (UTC)