Developer’s Guide

3-4 FileMaker Pro Developer’s Guide
Documenting your files
Although much of your documentation might be in a custom Help file,
you should create and distribute printed documentation for your solution
to cover items not appropriate or useful in help.
Here are some suggestions for items to include in the printed
documentation:
1 how to install your bundled solution
1 how to update to new solution files
1 how to use your onscreen help
1 how to start the solution (see “Opening your runtime solution” on
page 4-10)
1 what to do in case of a damaged file (see “Recovering damaged files”
on page 4-12)
1 how to reach you for technical support
You might also want to include the following recommendations:
1 Tell your end users not to rename any solution files (except the
runtime application), or they may be unable to run your solution.
1 Recommend that your end users back up their data regularly. You
might want to automate some of the process by including scripts that
save copies of the solution files. For more information on automating
a backup procedure, search the TechInfo database, included in the
Product & Support Information folder on the Developer Edition
CD-ROM. For information on using the TechInfo database, see
appendix B, “About the TechInfo database.”
Important In the event that your solution files become damaged, make
sure end users have access to your technical support phone number in
your printed documentation or in a text file. If the file is damaged, they
may not be able to access the “About” layout in your solution to find
your phone number.