Programming considerations for documentation and maintenance

ABSTRACT

The intent of this paper is to create, or reinforce among programmers an awareness of some simple measures which can be taken during application system development, which can save valuable time later, when somebody else is called upon to document, fix, enhance, or otherwise read and work with their programs. Although the paper describes several approaches to system documentation, it is not expected that any programmer will henceforth develop his applications exclusively around and according to the needs of the technical writer or maintenance analyst. The hope is that by describing a broad range of techniques, individual programmers can select those which best suit their style and approach, while minimizing the imposition of rigid and burdensome “standards”. The premise being that some, any, assistance provided to future readers, is better than none.

INDEX TERMS

Classification:
  D. Software
  D.2 SOFTWARE ENGINEERING
  D.3 PROGRAMMING LANGUAGES
      D.3.2 Language Classifications

          Nouns: APL

General Terms:
Design, Documentation, Languages, Management