Doc: ps2001-5-1101-001 Rev: R02. 00
Template module requirements
Download 1.5 Mb. View original pdf
|
1486357009-URS, URS
- Navigate this page:
- Documentation requirements
| Template module requirements (1) A series of template modules will be included with the software module library. Template modules will provide examples of how to do things within the software module library (for example, illustrate how a sequence operates and how it structures the modules it uses. (2) Template modules may contain a basic configuration that can be copied and used directly in the software, or may have a basic configuration that can be expanded and adapted to a particular application. (3) Template modules will provide stylistic information (i.e. they will provide a consistent appearance) that shall be adopted for all software modules developed from them, see § 4.6.5 for more details of the stylistic requirements. 4.5 Document module requirements (1) A series of document modules will be included with the software module library. Document modules will provide examples of how modules should be commented and shall be a quick access source of the various documentation models used within the software modules. (2) The document modules will provide examples of the documentation standards required for all aspects of the software module library, this will include, but not be limited to, the following • Block titles and header comments • Block descriptions • Version control • Network comments • Data structure and data storage comments 52-71 Doc PS Rev Rb Documentation requirements (1) The software module library will be extensively and comprehensively documented. The documentation will include but not be limited to the following • A user guide explaining the fundamentals of the library and detailed instructions in its use, see § 4.6.7 • Every library module will have its own specification, see § 4.6.4 • A stylistic guide explaining how to comment and structure the documentation within each module, see § 4.6.5 • Embedded documents for each module that are present within the library itself and can be accessed via TIA Portal (referred to as user defined documentation ), see § 4.6.6 • Version control within modules (revision tracking, see § 4.6.1 Download 1.5 Mb. Share with your friends:
|