! Does the program need other functions or programs?
! Can the program be intstalled in any folder, or does it have to be in a specific folder?
! How do I start the program?
! How do I exit (quit) the program?
! What Mode settings are needed? Does the program change my Mode settings? Does the program
restore my mode settings?
! Does the program change the current folder? Does it restore the previous folder?
! Does the program change my Graph screen? Does it change my Program I/O screen? Does the
program change any of my Y= Editor settings?
! Does the program leave any Data plot definitions behind?
! Does the program leave behind any global variables? What are there names? What happens if I
delete them, then run the program again?
! What other side effects does this program have?
! How does the program get its inputs from me? What are valid inputs? What are the units for the
inputs? Can the inputs be real or complex? If my input is a function name, how do I specify that
function?
! If this is a function, how do I call it? What are the calling arguments? Give examples.
! How does the program display the output results? What are the units? Are the results stored
anywhere?
! How accurate are calculated results? How can I check the accuracy? Does the accuracy degrade
for some input ranges?
! How long does it typically take for the program to get an answer?
! If the program duplicates a built-in function, why is it better? Is it faster, more accurate, or is it more
general?
! How much testing did you do on this program?
! Does the program display any error messages? What do the error messages mean? How do I fix
the errors?
! Does the program have built-in help? How do I get to it? Can I delete it to save memory?
! Where do I get help, if I need it?
! What is the version of this program?
! If this is a new version of the program, how is it different from the previous version?
! Does this program have any known bugs? How do I avoid them?
! Is this program based on someone else's work? How did you improve on their effort?
This is a fairly complete list, and all of these items might not be appropriate for all programs. You just
have to use your judgement as to what best serves the user.
How does the program get its results?
This section of the documentation describes how the program does what it does. For various reasons,
you might not want to tell the user how your program works. I believe this is a disservice to the user. If I
7 - 31
To Next Page
Loading...
Need help?
General
