ArsDigita Archives
 
 
   
 
spacer

Application Overview Template

by Joshua Finkler and Audrey Mcloghlin
The application overview is a new addition to aD application component documentation. The overview will be used in conjunction with requirements documentation and design documentation in an effort to standardize documentation for ACS 4.0 and future releases of the ACS. A quick review of the overview should allow any intelligent layperson to have a general understanding of the module's function and features.

I. The Big Picture:

The module overview section should be a short synopsis of the module's purpose and include the following items:
  • A high-level overview of how the module accomplishes its task.
  • What this module is supposed to allow the user to accomplish.
  • A much more detailed `Big Picture' will be found in the design documentation and include a detailed list of its features.


    II. Features:

    In contrast to `The Big Picture', this Features section should be a high level explanation of the modules main features. Be sure to keep this simple and display features in bullet form. A more detailed and thorough features list will be in the design document .



    III. Related Links:

  • Requirements Doc
  • Design Doc

  • jfinkler@arsdigita.com
    audrey@arsdigita.com
    spacer