Example Framework for Addressing Issues

Development and Testing Environment This is the Topic Title


MAXCON is modified and tested on the MAXCON production server. This is the Condition.



Some modifications to the existing applications can be problematic with unforeseen consequences and partially with unstable applications. This is the problem and example.



A MAXCON Development and Testing environment needs to be established to ensure modifications were implemented correctly and that no side effects have occurred. However production releases will require slightly more time than making changes directly on the production server. This is the Solution with Positives and Negatives.



We estimate that we need 10 hours to setup a Virtual Machine (VM) and run some initial test. This is the Level of Effort (LOF)



The text in italics is to explain the content and is not to be shown to the client.



It is important to be precise and clear. In other words, write as simple as possible. Additionally be consistent with nomenclatures, such as writing MAXCON in all upper-case. And always spell out abbreviations the first time mentioned in a document, for example: Virtual Machine (VM)



Also keep the associated Condition, Solution and LOF grouped together. And have a (Sub) Topic Header for each group.