Engineering Processes Standards Designs

Engineering Review Process

On 2016-11-18 we began a practice of conducting Engineering Reviews. During periodic (expected: weekly) meetings we would discuss and possibly accept proposals which were written and distributed prior to the meeting. These proposals might be for establishing or altering our development processes, standards, or designs. The expected focus for these proposals was initially to focus on the development of web server API interfaces. If this approach is helpful it could be expanded to other areas of development throughout the cBioPortal project.

Categories

• A Process is a specified way of doing something, with descriptions of steps to complete, the order or timeframe for completing them, the people to involve, and other factors required for properly completing the task.
• A Standard is a specification of criteria and factors which can be applied to determine the acceptability of some product or activity. Essentially it is a clear description of what is required or prohibited, desired or undesired, and other guidance for judging whether the standard has been met.
• A Design is a high (or middle) level choice of system structure, form, or dynamics. System development should be guided by these high level conceptual choices and avoid clashing with them. Examples would be definition of code components or modules, a definition of code layers and the interfaces between them, or a data model or data representation choice.

Organization

Wiki pages here will give indexes to relevant processes, standards, and designs. Individual pages will capture accepted proposals (or proposals completed through delegation), and will name the individual pages like this: {category}-{title} for example, EP-Engineering-Review-Meetings, for the process accepted 2016-11-18 category will be:

• EP for Engineering Process
• ES for Engineering Standard
• ED for Engineering Design

EP ES ED Links Page