Technical documentation in views and folders
Attribute(s)
Documentation
Description
All technical documentation must be written ('embedded') in the application itself. This includes technical information regarding a view or folder.
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 view should be documented with @Remark statements in the
view or formula selection (formula) window.
Embedded_Technical_Documentation_View.jpg