Sdd Documentation


Published on

Published in: Technology
1 Like
  • Be the first to comment

No Downloads
Total views
On SlideShare
From Embeds
Number of Embeds
Embeds 0
No embeds

No notes for slide

Sdd Documentation

  1. 1. Maintenance of Software Solutions Documentation of Changes
  2. 2. What happens when a modification is made? <ul><li>When modifications are made all internal and external documentation may also need to be altered. </li></ul><ul><li>Large projects that have multiple modifications may also require monitoring and tracking of changes which is also a facet of documentation. </li></ul><ul><li>Identify how modifications are tracked in </li></ul><ul><li>computer programs. </li></ul>
  3. 3. What happens when a modification is made? <ul><li>Versioning </li></ul>
  4. 4. Modification Of Internal Documentation <ul><li>All altered source code should contain the following: </li></ul><ul><ul><li>Who made the change? </li></ul></ul><ul><ul><li>Date </li></ul></ul><ul><ul><li>Changes evident. </li></ul></ul><ul><li>Should employ all strategies used when documenting the solution in other stages. </li></ul>
  5. 5. Activity – Internal Documentation <ul><li>A client database program has been modified to include new search and print modules. Also a sort procedure has been changed to incorporate a selection sort rather than a bubble sort. </li></ul><ul><li>Identify THREE areas of internal documentation that should be modified to ensure that effective maintenance can be continually implemented. </li></ul>
  6. 6. Activity – Internal Documentation <ul><li>Answer </li></ul><ul><li>Intrinsic Naming </li></ul><ul><li>Indentation of control structures </li></ul><ul><li>Comments </li></ul>
  7. 7. Modification Of External Documentation <ul><li>The changes in the structure of a program may also have an effect on external documentation related to the program. </li></ul>
  8. 8. Activity – External Documentation <ul><li>HP has just developed a new driver for its HP890 printer. The new driver supports users to change the RGB colours used and also to print in a low usage monochrome mode. </li></ul><ul><li>Identify the documentation changes that should be made to ensure users are well informed and supported regarding changes. </li></ul>
  9. 9. Activity – External Documentation <ul><li>Answers </li></ul><ul><li>Changes to online help. </li></ul><ul><li>Changes to tutorials. </li></ul><ul><li>Changes to printer common dialog box. </li></ul><ul><li>Changes to the print driver link on the website. </li></ul><ul><li>Informing users of changes. </li></ul>
  10. 10. Use of CASE Tools <ul><li>Maintenance is definitely a complex and time consuming process. </li></ul><ul><li>CASE tools are available to automate this process. </li></ul>
  11. 11. Examples – Version Control <ul><li>Version control CASE tools manage multiple versions of software components or modules. </li></ul><ul><li>Records of previous versions are kept and maintained. </li></ul><ul><li>Major changes create a version to change from 2.5 to 3.0. </li></ul><ul><li>Minor version changes will result in a cahnge from 4.1 to 4.2. </li></ul>
  12. 12. Activity <ul><li>Create a timeline of the various major versions of Microsoft Windows. </li></ul>
  13. 13. Answers <ul><li>Windows 1.0, 2.0, 3.0, 3.1 </li></ul><ul><li>Windows 95 </li></ul><ul><li>Windows NT 4.0 </li></ul><ul><li>Windows 98 </li></ul><ul><li>Windows 2000 </li></ul><ul><li>Windows ME </li></ul><ul><li>Windows XP </li></ul><ul><li>Windows Longhorn </li></ul>
  14. 14. Activity <ul><li>The developer of a program called OOTher uses a CASE tool to assist in documenting the versioning notes and help users understand modifications. </li></ul><ul><li>Modifications </li></ul><ul><li>Version 1.01 </li></ul><ul><li>Bug corrections to eliminate 2/0 error. </li></ul>
  15. 15. Activity <ul><li>Version 1.02 </li></ul><ul><li>Changes to save dialog box colours. </li></ul><ul><li>Version 1.11 </li></ul><ul><li>Changes to menus in GUI. </li></ul><ul><li>Version 2.01 </li></ul><ul><li>Changes to print module to allow a new driver. </li></ul>
  16. 16. Activity <ul><li>Answer the following: </li></ul><ul><li>Identify what type of change would have occurred between 1.11 and 2.01. </li></ul><ul><li>Draw a hierarchy chart to show the different versions. </li></ul><ul><li>Identify where a programs version number is normally displayed. </li></ul>