Documenting the development effort

Vertex42 The Excel Nexus

Professional Excel Templates

Get Instant Access

Putting a spreadsheet application together is one thing. Making it understandable for other people is another. As with traditional programming, it's important that you thoroughly document your work. Such documentation helps you if you need to go back to it (and you will), and it helps anyone else whom you might pass it on to.

You might want to consider a couple of things when you document your project. For example, if you were hired to develop an Excel application,you might not want to share all your hard-earned secrets by thoroughly documenting everything.If this is the case,you should maintain two versions:one thoroughly documented and the other partially documented.

How do you document a workbook application? You can either store the information in a worksheet or use another file. You can even use a paper document if you prefer. Perhaps the easiest way is to use a separate worksheet to store your comments and key information for the project. For VBA code, use comments liberally. (VBA text preceded with an apostrophe is ignored because it's a comment.) Although an elegant piece of VBA code can seem perfectly obvious to you today, when you come back to it in a few months, your reasoning might be completely obscured unless you use the VBA comment feature.

Was this article helpful?

0 0

Post a comment