ACS Engineering Standards

collected from the ACS4 development team

ACS Documentation : ACS Engineering Standards

We have introduced a number of engineering standards in ACS4 and expanded upon a number of old ones. The Engineering Standards Manual documents and formalizes these standards, as well as explains how to write a package to take advantage of the new mechanisms provided by the ACS core.

Programming Standards

General programming standards: programming style guidelines, with Java examples.
PL/SQL Engineering Standards: conventions and styles we follow when programming in PL/SQL
ACS File Naming and Formatting Standards: how ACS files should be named, formatted, and organized.
ACS SQL standards: guidelines for writing SQL queries, formatting queries, and data model conventions.
ACS naming standards: conventions used to name TCL and SQL procedures and tables in the ACS.
ACS constraint naming: conventions on how to name constraints.

Documentation Standards

There are several types of documentation that are necessary for each package. The standards that are followed by the kernel and core are special, and worth documenting. Specifically:

Kernel-level requirements and design documents are part of the ACS Kernel Documentation, and are stored as part of the acs-kernel package.
Kernel-level programmer's documentation forms the ACS4 Application Developer's Guide, and are stored as part of the acs-core-docs package.
General engineering standards that should be upheld ACS-wide form the ACS Engineering Standards Guide, which is also kept as part of the acs-core-docs package.

Non-core packages should in general have requirements, design, programmer, and possibly user-level documentation all stored in the /doc of the package, with an index page linking to each piece of documentation.

acs@arsdigita.com

Last Modified: index.html,v 1.1 2001/01/21 01:49:07 bquinn Exp