Special Edition Using FileMaker 8

Chapter 27. Documenting Your FileMaker Solutions

In this chapter

• Why Is Documentation Important? 842

• Developing Naming Conventions 842

• Using Comments Effectively 843

• Documenting the Relationships Graph 845

• Using the Database Design Report 846

• Using Third-Party Documentation Tools 849

• Putting the Finishing Touches on Your Documentation 850

• Final Thoughts on Documentation 851

• FileMaker Extra: Soliant Development Standards 851

Why Is Documentation Important?

There are two general types of software documentation: user instructions and system documentation. User instructions generally assist people who need to use or administer an application. System documentation is a resource for developers who need to make functional changes to a system. This chapter focuses ...