The Importance of Documentation

2382 Words5 Pages
bulb-icon

Recommended: Importance of documentation is easy

Documentation Documentation is necessary to any environment or project whether it is in development or in production. According to Azarian, documentation is crucial to track all aspects of the application from development to maintenance to knowledge transfer. (2013) Documentation will assist in understanding business rules, the database and files, troubleshooting issues that may arise, installation of applications, and deploying code. I cannot emphasize enough about the importance of documentation. There are many questions that need to be answered when choosing a documentation technique. Those questions are as follows. First question would be if it allows me to return to working on the system after I have been away from it for a period of time. Second question is if it is compatible with existing documentation. Third question would be if it would allow for easy modification. A fourth question would be if it would be understood by others in the company. Yet another question I can ask is if it allows for a structured design approach. And finally is if it is suitable for the size of the system I am working on. (Kendall & Kendall, 2011) In this scenario we have many different points of view on how to proceed for documenting the project. Those differences and valid opinions are psuedocode from Al Gorithm, CASE tools from Flo Chart, and flowcharting from David Downlode. Each of the members 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 that is very used to using pseudocode to convey the work he performs while he codes. The problem with pseudocode for documentation is that it wasn’t designed for it. Pseudocode ... ... middle of paper ... ...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.htm Report: Government Failed to Secure 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 Estimate Testing Time Accurately. 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

Show More
Related

  • Practicum Project: Creating a Women and Infants Clinical Summary Screen

    2010 Words  | 5 Pages

    This practicum project experience project plan is the initial step in addressing an identified deficiency in the new CPOE/clinical documentation system implemented last year at the medical center at which I am employed. Using the standardized tools of project management, I have presented the project objectives, the global project methodology, and the formative and summative evaluation criteria. To further describe this project plan, a graphical timeline is shown in figure 1. A narrative explanation of the timeline is included in the appendix. Finally, this project plan is supported by scholarly and peer-reviewed literature.

    Read More

  • Res Ipsa Loquitur Analysis

    348 Words  | 1 Pages

    Documentation is key in defending oneself, especially when cases are brought up, as my classmates mentioned, many years after the fact. Documentation is also important in order to provide a flow or a routine in the care being provided. For example, Nagelhout’s book talks about the flow of anesthesia practice during induction, in almost all

    Read More

  • Evidence and Documentation, by Joseph Donohue

    843 Words  | 2 Pages

    In “Evidence and Documentation” Donohue sets out to prove that the theatre scholar’s attempt at citing evidence and proper documentation is severely problematic because the notion of what evidence and documentation means is flawed. Donohue builds his argument by providing the reader with definitions of evidence and documentation and how most scholars use these definitions. Donohue then provides reasoning why these definitions are questionable. Documentation, Donohue implies, is general information until it is used in a way that seeks to create new knowledge or to change the reader’s perception on what is already learned. Donohue negates the broad definitions of these two terms and provides what he believes to be very effective definitions of evidence and documentations. He states that, “the ultimate question is always what the scholar who uses it does with it…the question is finally one that has to do with interpretation-with history” (Donohue 181). Continuing to strengthen his argument, Donohue brings to light the authority of certai...

    Read More

  • Clinical Documentation Improvement Paper

    630 Words  | 2 Pages

    Clinical Documentation Improvement also has connections to reimbursement, quality of healthcare, and public reporting; and facilities rely on CDI for all of it.

    Read More

  • Clinical Documentation Improvement (CDI)

    483 Words  | 1 Pages

    this will cause healthcare providers with the training and education needed for clinical documentation improvements to be installed effectively. It is important that having a specialized team who can create solutions towards Clinical Documentation Improvement (CDI) in order to minimize the failures that may occur. In this case, investing in training for the materials/tools necessary for healthcare providers to excel in their work with CDI. Essentially, Clinical Documentation is used throughout the healthcare system for the analysis of care, communication, and medical records. This is important because the information of medical records that healthcare providers are able to access, will help patients track their health conditions. Thus, clinical documentation improvement has a direct impact on patients by providing quality information. On the other hand, the new technological advancements will also be able to address the efficiencies in health care system that differ from paper-based charting. Improving on the quality of information will also have the effect upon the ethical and effectiveness of care that is being provided. This has a significant impact in order to maintain patient care that ensures the documentation is accurate, timely, and reflect within the services provided. Documentation assessments can be utilized so there can be improvements on the education for healthcare providers as they intend implementation standards take effect immediately. In this case, failures must be analyzed so that they will have the ability to comprehend and determine an organization’s strengths and weaknesses

    Read More

  • Essay On Nursing Documentation

    695 Words  | 2 Pages

    Nursing documentation is an important factor of healthcare delivery today. The use of information and communication technology offers opportunities for improving patient care delivery while reducing nurses’ documentation load and increasing the time available for caring for various patient populations (Munyisia, Yu, & Hailey, 2012).

    Read More

  • Nursing Documentation In Nursing

    1462 Words  | 3 Pages

    Documentation is proper recording as regards to time, place, circumstances and attribution. It’s a written record of information. Communication is the first important step to documentation because nurses can’t document a patient information and medical history without interacting with them. Even the simplest statement could end up becoming very important when determining a treatment or even diagnosis.

    Read More

  • Module 5 Paragraph Analysis

    265 Words  | 1 Pages

    There are numerous benefits that I have observed by writing important information down. One of them being that it shows my superiors that I’m a responsible employee because I don’t forget information. Another benefit is that I always have something to look back on to remind me of crucial information.

    Read More

  • Summary Of A Charge Nurse

    1155 Words  | 3 Pages

    On a daily basis, I will have to engage in charting and documentation writing to ensure patients receive the best possible care. Charting will involve patient identification, legal forms, observation, and progress notes. Documentation must be factual with objective information about the patients’ behaviors. Accuracy and conciseness are crucial characteristics of documentation in the nursing profession so that other medical professionals can quickly read over the information (Sacramento State,

    Read More

  • Nursing Essay: Patient Assessment

    2489 Words  | 5 Pages

    Good documentation remains in line with the NMC Code of Professional Conduct 2008 and to promote better communication (NMC 2008).

    Read More

  • Rational Unified Process

    1248 Words  | 3 Pages

    A documentation framework is essential for any large project; hence, RUP describes how to document functionality, constraints, design decisions and business requirements. Use Cases and Scenarios, are examples of artifacts prescribed by the process and have been found to be very effective at both capturing functional requirements and providing coherent threads throughout the development and deployment of the system.

    Read More

  • The Importance Of Documentation In Nursing

    1651 Words  | 4 Pages

    The principles of documentation is clear, confidential, accurate, complete and concise, objective, organized and timely. Using documentation nurses are required to legally and ethically keep all information in the patient record confidential. There is the Health Insurance Portability and Accountability Act, known as HIPAA, which helps gives patients a greater control over their health care record (). Precise measurements and times must be used as much as possible. Accuracy can be enhanced through point of care documentation (Craven, 2017). The accuracy of documentation can be view from three perspectives veridical reflection of nursing, comprehensive while through detail of a patient journey and finally clarity in usage terms (Britain Summer of Nursing). The accuracy part is the really vital part in documentation within nursing because it shows the complete reflection of the stages of care that was provided by the health care professionals to an individual. Next, when an individual is documenting it needs to be complete and concise and organized. Having the report done as so allows for any health professional to find any information quick as possible without having to search throughout the entire chart for answers. When reporting it needs to be in a chronical flow order of the information about the patient care and procedures being done, within the chronological

    Read More

  • Proper Aircraft Maintenance

    884 Words  | 2 Pages

    "Proper Documentation Means Better Aircraft Maintenance – Documents Aircraft Owners Should Have |." Proper Documentation Means Better Aircraft Maintenance – Documents Aircraft Owners Should Have. Jason Blair, 18 Aug. 2013. Web. 3 Jan. 2014. .

    Read More

  • The Importance Of Pediatric Nursing

    923 Words  | 2 Pages

    The authors of this article helped support their points on the importance of documentation by analyzing the different charting techniques, interviewing nurses within the field, as well as forming a number of focus group

    Read More

  • The Importance Of Technical Communication

    710 Words  | 2 Pages

    Technical Communication in my term is the way we interact with non-living objects. This includes Bank Machines, Mobil Devices, or just simple instructions for technology. According to Laura J. Gurak and John M. Lanno reading "Strategies for Technical Communication in the Workplace" says "Technical communication is the exchange of information that helps people interact with technology, advance workplace goals, and solve complex problems" (Gurak, Lannon 3). We deal with technical communication on a daily basis, at work, home, or even going out to eat. It says on page three of Strategies for Technical Communication in the Work Place, that technical communication is used constantly in a work based environment, Nurses and other medical workers are

    Read More

More about The Importance of Documentation

Open Document