Technical documentation form

Attribute(s)

  • Documentation

    Description

    All technical documentation must be written ('embedded') in the application itself. This includes technical information regarding a form

    Motivation

    This approach both facilitates the use of e.g. Teamstudio's Teamstudio Analyzer product as a documentation tool and allows for immediate understanding by a designer as to what the purpose of a design element is.

    Example / Details

    Any required technical information regarding the basic function or any specific characteristics of a form should be documented with @Remark statements in the Window Title.

    Example:



    •  29 Jul 2008  07:15:27 AM CDT  Pepijn Hammecher/AtosOrigin

     |  |  | | | documentation | form


    Embedded_Technical_Documentation_form.jpg