tailieunhanh - Chapter 17: Exam Documentation

We know that you all know the benefits of thorough, accurate, and understandable documentation. There may be some of you out there who wish that documentation wasn’t an integral part of a programmer’s job. There may be others of you who are thrilled to write documentation, to exercise a different part of your brain, to help your fellow programmers, to capture (hey you, in the back, stop laughing!) your company’s technical assets. | JAVA 2 SUN CERTIFIED PROGRAMMER DEVELOPER 17 Exam Documentation CERTIFICATION OBJECTIVE Understand the Sun Certified Java Developer Exam Documentation Requirements 2 Chapter 17 Exam Documentation CERTIFICATION OBJECTIVE Understand the Sun Certified Java Developer Exam Documentation Requirements We know that you all know the benefits of thorough accurate and understandable documentation. There may be some of you out there who wish that documentation wasn t an integral part of a programmer s job. There may be others of you who are thrilled to write documentation to exercise a different part of your brain to help your fellow programmers to capture hey you in the back stop laughing your company s technical assets. Well whatever your inclination you re going to have to write good solid documentation to support your project if you want to have any chance of passing this exam. It turns out that proper documentation plays as big a role in determining your exam score as many of the software aspects themselves. The assessors will be expecting several pieces of documentation when you submit your exam. They are discussed briefly in the exam packet you receive from Sun we will go into them more thoroughly in this chapter. The five areas of project documentation that we will cover are Developer s Documentation End User Documentation javadoc The Developer Choices File Comments and the Version File Developer s Documentation This area of the project s documentation is the most open ended. Your assessor is most interested in the final results of your project these optional documents represent the design work that you did as you were working on the project. Documentation that you might consider providing in this section includes UML diagrams schema documentation algorithm documentation flow diagrams prototype plans and test results. Given that the rest of the standalone documentation is to be submitted via ASCII text files or HTML we recommend the same here. Understand the Sun .