Topic > The Importance of Documentation - 2382

DocumentationDocumentation is necessary for any environment or project, be it in development or production. According to Azarian, documentation is key to keeping track of all aspects of the application, from development to maintenance to knowledge transfer. (2013) Documentation will help you understand business rules, database and files, troubleshoot problems that may arise, install applications, and deploy code. I can't stress enough the importance of documentation. There are many questions that need to be answered when choosing a documentation technique. These questions are as follows. The first question would be whether it will allow me to return to working on the system after I have been away from it for a period of time. The second question is whether it is compatible with existing documentation. The third question would be whether it would allow for easy modification. A fourth question would be whether it would be understood by others within the company. Another question I can ask is whether it allows for a structured design approach. And finally whether it is suitable for the size of the system I am working on. (Kendall & Kendall, 2011) In this scenario we have many different views on how to go about documenting the project. These valid differences and opinions are Al Gorithm's pseudocode, Flo Chart's CASE tools, and David Downlode's flowcharts. Each member has their own reasons why their options are valid, but each of these approaches is not the best choice for standardization. Al Gorithm comes from a programming background very accustomed to using pseudocode to convey the work he does while coding. The problem with documentation pseudocode is that it wasn't designed for that. Pseudocode ...... middle of the document ...... 14 from http://www.softwaretestinghelp.com/why-documentation-is-important-in-software-testing/Pseudocode Examples. (1999). Retrieved March 13, 2014, from http://www.unf.edu/~broggio/cop3530/3530pseu.htmReport: Government Failed to Protect Obamacare Site. (2014). Retrieved from http://www.newsmax.com/US/obamacare-website-hackers-government/2014/01/16/id/547379/Ross, T. (2008). The importance of using "real" test data. Retrieved from http://timross.wordpress.com/2008/04/20/the-importance-of-using-real-test-data/Sandhya, N.R. (n.d.). Software Test Estimation: 9 General Tips on How to Accurately Estimate Testing Time. Retrieved March 15, 2014, from http://www.softwaretestinghelp.com/software-test-estimation-how-to-estimate-testing-time-accurately/Standard Operating Procedures. (n.d.). Retrieved March 13, 2014, from http://www.fao.org/docrep/w7295e/w7295e04.htm