Documentation
Übersicht
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.
Ziele
- 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.
Lektionshinweis
Verfügbar in der Green Bridge App
Laden Sie die Green Bridge CBT App auf Ihr Telefon oder Ihren Computer herunter, um auf vollständige Lernnotizen, Übungsfragen und mehr zuzugreifen.
Unterrichtsbewertung
Herzlichen Glückwunsch zum Abschluss der Lektion über Documentation. Jetzt, da Sie die wichtigsten Konzepte und Ideen erkundet haben,
Sie werden auf eine Mischung verschiedener Fragetypen stoßen, darunter Multiple-Choice-Fragen, Kurzantwortfragen und Aufsatzfragen. Jede Frage ist sorgfältig ausgearbeitet, um verschiedene Aspekte Ihres Wissens und Ihrer kritischen Denkfähigkeiten zu bewerten.
Nutzen Sie diesen Bewertungsteil als Gelegenheit, Ihr Verständnis des Themas zu festigen und Bereiche zu identifizieren, in denen Sie möglicherweise zusätzlichen Lernbedarf haben.
- 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
Verfügbar in der Green Bridge App
Laden Sie die Green Bridge CBT App auf Ihr Telefon oder Ihren Computer herunter, um auf vollständige Lernnotizen, Übungsfragen und mehr zuzugreifen.
Verfügbar in der Green Bridge App
Laden Sie die Green Bridge CBT App auf Ihr Telefon oder Ihren Computer herunter, um auf vollständige Lernnotizen, Übungsfragen und mehr zuzugreifen.
Empfohlene Bücher
Übungsklausuren üben
Möchten Sie Übungsklausuren zu Documentation üben? Laden Sie die Green Bridge CBT App herunter, um Übungsklausuren und vollständige Prüfungssimulationen zu diesem Thema zu erhalten.
Lade die App im Google Playstore herunter.
Alles, was du brauchst, um in JAMB, WAEC & NECO zu glänzen.
