Internal USGS Only

Documents Prepared by the Software Issues Team

SIT included the Chief or a representative from the software development groups AIS, NWIS, HASS, DIS, NWQL, and HIF CSS and a representative from a District. The functions of SIT, the Planning and Implementation Committee (PIC) for DIS-II, and the Strategic Planning Group (SPG) have been included in a new committee, the Computer Planning Advisory Committee (CPAC). SIT was instrumental in the development of the new committee.

SIT, by the establishment of Process Action Teams, produced several products of interest to the Division that are listed below.

Fortran Language Coding Convention, Open-File Report 94-501

Fortran Coding Convention (OFR-94-501) prepared by: Kate Flynn, Jeff Christman, Jon Scott, John Terry.

The coding convention includes both the implementation of selected Fortran features and a recommended coding style. It is designed to simplify the tasks associated with software support, maintenance, and distribution and is an important element in software quality assurance plans. The report also describes the program SYSDOC which can be used to produce detailed documentation for code that follows the coding conventions.

Contact kmflynn@usgs.gov for a printed copy of the report.

C Language Coding Standards

C Coding Standards prepared by: Merritt Blalock, Jim Fulton, Mark Farmer, Jim Morris.

Coding guidelines promote the development of software that is portable, readable, and maintainable. Good programming is more a result of an informed attitude than the rote following of guidelines. This document minimizes rigid requirements in the hope of leading programmers to good practices through the merits of the presented guidelines.

Configuration Management Proposal

Combined Configuration Management Proposal prepared by: Kate Flynn, Gail Kalen, Richard Husband, Mindy Lanza, Ruth Thornberg, Tom Wood, Cheryl Nelson.

Configuration management is a baseline management system that can provide managers control of all phases of design, development, review, and system integration for the production and maintenance of software and hardware systems. The proposal provides a recommended approach for implementing configuration management in the Water Resources Division.

Software Documentation Guidelines

Software Documentation Proposal prepared by: Steve Regan, Alan Burns, Glenn Hearne, Sharon Mathey, James Lewis, Kimberly Rogers, David Boldt.

The report provides guidelines for planning, writing, and quality assurance of computer software documentation for the users of the software within the U.S. Geological Survey. The goal of the report is to introduce standard methodologies and processes to clarify and simplify the tasks of creating consistent (in terms of quality, design, content, and style) user's documentation. Documentation products covered in the guidelines include: Source-Code Header, Software Abstract, Manual Page, Quick Reference Guide, Tutorial, User's Guide, Reference Guide, Programmer's Guide, Installation Guide, and Methods Guide.

Shared Software Library Proposal

Software Library Proposal prepared by: Jeff Christman, Randy Fields, Kate Flynn, George Hawkins, Frank Letellier, Scott McFarlane and Jon Scott.

A shared software repository (library) would reduce costs of developing, maintaining, and porting software developed and used by the Water Resources Division. Savings would result from reduced duplication of effort, improved quality by implementing standards, improved availability by guaranteed distribution, and improved usability of the software by implementing documentation requirements. The report provides plans for implementation of a shared software library.

USGS :: ITAC :: Water :: Water Intranet :: WICAS

Address questions or comments to:

Kym Burns, ITAC Executive Secretary
(703) 648-5609