Documentation
Overview
A working system is only half the job. The people who use it need to know how to operate it, and the people who will fix and improve it later need to understand how it was built. Both needs are met by documentation, written alongside the system. Skimp on it and users flounder while future programmers waste days working out what the original team already knew.
In this lesson you will learn the two kinds of documentation produced for a new system: technical documentation, aimed at programmers and analysts, and user documentation, aimed at the people who use the software day to day. You will learn the purpose of each and the specific components each one contains, and how to decide which document a given item belongs in.
Objectives
- Documentation.
- Characteristics, uses and purpose of technical and user documentation Components of technical documentation including: purpose of the system/program, limitations of the system, program listing, program language, program flowcharts/algorithms, system flowcharts, hardware and software requirements, file structures, list of variables, input format, output format, sample runs/test runs, validation routines Components of user documentation including: purpose of the system, limitations of the system, hardware and software requirements, how to load/ run/install software, how to save a file, how to print data, how to add records, how to delete/edit records, input format, output format, sample runs, error messages, error handling, troubleshooting guide/helpline, frequently asked questions, glossary of terms.
Lesson Note
Available on the Green Bridge App
Download the Green Bridge CBT app on your phone or computer to access full lesson notes, practice questions, and more.
Lesson Evaluation
Congratulations on completing the lesson on Documentation. Now that youve explored the key concepts and ideas, its time to put your knowledge to the test. This section offers a variety of practice questions designed to reinforce your understanding and help you gauge your grasp of the material.
You will encounter a mix of question types, including multiple-choice questions, short answer questions, and essay questions. Each question is thoughtfully crafted to assess different aspects of your knowledge and critical thinking skills.
Use this evaluation section as an opportunity to reinforce your understanding of the topic and to identify any areas where you may need additional study. Don't be discouraged by any challenges you encounter; instead, view them as opportunities for growth and improvement.
- A program listing (the code) would appear in which documentation? A. User documentation B. Technical documentation C. Both D. Neither Answer: B
- A troubleshooting guide and FAQs would appear in which documentation? A. Technical documentation B. User documentation C. Neither D. The program listing Answer: B
- Which item appears in BOTH technical and user documentation? A. List of variables B. Program flowcharts C. Purpose of the system D. Known bugs Answer: C
- Technical documentation is written mainly for: A. End users B. Customers C. Programmers and analysts D. Managers only Answer: C
- Which of these belongs only in user documentation? A. System flowcharts B. How to add or delete records C. List of variables D. Programming language used Answer: B
Available on the Green Bridge App
Download the Green Bridge CBT app on your phone or computer to access full lesson notes, practice questions, and more.
Available on the Green Bridge App
Download the Green Bridge CBT app on your phone or computer to access full lesson notes, practice questions, and more.
Recommended Books
Practice Mock Questions
Want to practice mock questions on Documentation? Download the Green Bridge CBT app to access mock questions and full practice assessments for this topic.
Download The App On Google Playstore
Everything you need to excel in JAMB, WAEC & NECO
