Wikipedia:Reference desk/Archives/Computing/2007 June 15

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.

June 15

How to write software documentation

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.

Here's one possible outline:

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)

How can you type overdot letters such as Ȧȧ without copy and pasting?

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)

What Operating System (Windows, Mac, Linux?) and what program (Word, OpenOffice, Vim?) Youth in Asia 00:55, 15 June 2007 (UTC)

It depends heavily on the Operating System. However most have what are called Internationalization settings which allow you to add keyboard supports for other languages. Otherwise there are usually ways to enter in Unicode characters though they are not always easy (i.e. the make you memorize arbitrary numbers). --24.147.86.187 01:50, 15 June 2007 (UTC)

Take a look at Windows Alt keycodes. JoshHolloway 10:06, 15 June 2007 (UTC)

On the mac, there's a unicode keyboard which makes the various diacriticals pretty easy. It's just a matter of typing option-w followed by the letter with the overdot. You would want to select U.S.-extended as the keyboard from the internationalization preference pane.Donald Hosek 17:37, 15 June 2007 (UTC)

Sorry, I'm using Windows XP Service Pack 2, and I need to be able to type in Mozilla Firefox, or any web browser and unfortunately the Internationalisation settings don't have Gaelic, and I'm looking for something a little easier than Unicode, as there doesn't seem to be a keystroke for the letters I need it's all copy and paste, and in Unicode, even most of the letters above aren't there. I've tried the Macintosh Option+W method and it's extremely simple, is there any way that the Windows operating system may do the same?

It might be overkill (and it's not cheap), but if you can wait until December, you could try the Optimus Maximus keyboard... —Steve Summit (talk) 15:37, 16 June 2007 (UTC)

No, I think that option is a bit out of the way for something that should seem very simple, and is very simple on Mac... Also there's no guarantee that it will work for what I need once I buy it...

Compiling for OSes other than the one the compiler runs on

Can a version of G++ that runs under Linux compile programs to run console-mode in Windows? NeonMerlin 01:32, 15 June 2007 (UTC)

Yes, see Cross compiler, it may be easier to compile it to run in Cygwin than natively though. --antilived^{T | C | G} 06:48, 15 June 2007 (UTC)

At least Debian and Ubuntu have mingw cross-compiler packages, so not only it's possible, it's also quite easy (you don't even have to compile your own cross-compiler). --cesarb 22:45, 15 June 2007 (UTC)

Protecting rating systems against gaming

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)

Some suggestions:

• Only allow registered users to add ratings, and then only after a suitable period.

• Require that users identify a sequence of letters and numbers disguised in a pic to make it difficult for computers to register. Also repeat this test with a different sequence during each rating.

• Require that people actually view the video, play the game, etc., before they are allowed to rate it. Block accounts which do nothing but rating.

• Limit accounts to a certain number of ratings per day.

• Check the I/P address and only allow one rating per item per I/P address. StuRat 23:22, 18 June 2007 (UTC)

BACK

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)

Under Windows 98, I right click on the IE icon and pick "Properties", then click on the "Security" tab, then pick the "Custom Level" button. That gives me a list of security settings. One of those is likely set to "Prompt" when it should be set to "Enable". Look through the list; if you find a likely candidate, change the setting, pick OK, and try your test again. If that's not the right setting, put that one back and try another, until you find it. You may need to restart IE for the change to take effect. StuRat 23:11, 18 June 2007 (UTC)

WARNING: If you make purchases online, then go back to that page and resubmit you may be charged again. Be very careful about diabling the security warning. It is enabled for a reason. Tswsl1989 12:45, 20 June 2007 (UTC)

Motherboard broken?

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)

Perhaps you didn't seat the video card correctly? Splintercellguy 19:25, 15 June 2007 (UTC)

The BIOS beep codes usually aren't on the motherboard manual; there are several pages on the web listing them, just search for "BIOS beep codes". Check not only that the card itself is correctly seated, but also that all the other cards and cables are correctly seated/connected; it's easy to bump on something else without noticing (or something else wasn't correctly seated to begin with and moving the case moved it). --cesarb 22:43, 15 June 2007 (UTC)

Hey Dirk! If the graphics card works in another computer, maybe you have access to a spare graphics card that you can put into the motherboard in question?

Also, after the dodgy computer beep, is there any indication that the computer is continuing to load the operating system (i.e. harddrive light flashing/haddrive sounds or the startup sounds playing through the speakers, if applicable. If you have to type a password to finish loading the OS and hear the startup sound, wait a few minutes so that the computer would be at the password prompt and then type it and hit enter).

Finally, does your computer have an onboard video card? I once plugged my monitor into the socket for the onboard video card instead of the one I had installed in its AGP slot. I doubt that's the case, but I have now emptied my head of all suggestions except to try the forum for your make of motherboard; I use an MSI board and the forum is pretty helpful. Good luck! --Seans Potato Business 00:14, 17 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)

clip drives with linux

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)

To people wondering what a "clip drive" is, a quick Google search shows it seems to be yet another name for a USB flash drive. It should work, but since it's an older distribution I don't know whether it will automatically mount the drive or you will have to use the command line to do it. --cesarb 22:36, 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?

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)

The point you are missing is that wireless networks are bidirectional, while broadcast TV is unidirectional. Broadcast TV only has a few transmitters (each TV station) for several receivers (each TV set), and each transmitter has its own separate frequency; wireless networks have a lot more transmitters (each receiver also has a transmitter), all sharing the same few frequencies, so just increasing the power would only increase the noise for everyone else. --cesarb 22:28, 15 June 2007 (UTC)

Got it - muchos gracias!

Gracia is female, so that would have to be 'muchas gracias'. Then again, this is not the language ref desk. :) DirkvdM 06:38, 17 June 2007 (UTC)

Cheap Notebook

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.

link

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?

I've had very good experiences with Acer laptop and desktop machines at work (except that I really dislike the way they partition the disk with half the space reserved for Norton Ghost backups - I generally repartition that away). -- Finlay McWalter | Talk 20:54, 15 June 2007 (UTC)

I personally haven't got an acer laptop but they are good overall and if you like that one and you know your sister would like it then i would buy it. They are very reliable and won't break easily. My school has some and they have never failed. If you want more reading on the business i suggest you go to wikipedia's article on Acer (company)Wiki.user 21:25, 15 June 2007 (UTC)

If you're willing to take a small performance cut, I'd go with http://microcenter.com/single_product_results.phtml?product_id=0257720 - a good 100$ cheaper. Also, Asus recently announced a budget laptop starting at 190$, but there's no word on when that will come out, and it's features are a little on the bare side (see OLPC for an idea of what it would be like, although they're different efforts) -- Phoeba Wright^OBJECTION! 22:35, 15 June 2007 (UTC)

Umm, I'd only buy a laptop at the moment that had a dual core processor, end of story. Nearly all new PCs ship with them, including laptops, and you should be able to find many laptops under $500 with a Core 2 Duo or at least a Celeron D. Since laptops are for the most part un-upgradeable, you don't want to buy something that'll need to be trashed in a couple years as applications start increasing specifications to match multicore machines - Photoshop and CAD software are much quicker with dual core processors, already. -Wooty [Woot?] [Spam! Spam! Wonderful spam!] 05:58, 21 June 2007 (UTC)

Weekedit

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)

Ummm...you just go to the website YOU! provided https://addons.mozilla.org/en-US/firefox/addon/1662, and then click on Install now on the button below the info...and then you click on accept and install because it has a license agreement...and then it um....installs? I'm on Firefox 2.0.0.2 and it worked...so something might be up if you don't see the buttons to install the extension... 200.35.168.129 18:54, 18 June 2007 (UTC) Ag for MemTech