Documentation
Overzicht
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.
Doelstellingen
- 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.
Lesnotitie
Beschikbaar in de Green Bridge-app
Download de Green Bridge CBT-app op je telefoon of computer voor toegang tot volledige lesnotities, oefenvragen en meer.
Lesevaluatie
Gefeliciteerd met het voltooien van de les op Documentation. Nu je de sleutelconcepten en ideeën, het is tijd om uw kennis op de proef te stellen. Deze sectie biedt een verscheidenheid aan oefeningen vragen die bedoeld zijn om uw begrip te vergroten en u te helpen uw begrip van de stof te peilen.
Je zult een mix van vraagtypen tegenkomen, waaronder meerkeuzevragen, korte antwoordvragen en essayvragen. Elke vraag is zorgvuldig samengesteld om verschillende aspecten van je kennis en kritisch denkvermogen te beoordelen.
Gebruik dit evaluatiegedeelte als een kans om je begrip van het onderwerp te versterken en om gebieden te identificeren waar je mogelijk extra studie nodig hebt. Laat je niet ontmoedigen door eventuele uitdagingen die je tegenkomt; beschouw ze in plaats daarvan als kansen voor groei en verbetering.
- 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
Beschikbaar in de Green Bridge-app
Download de Green Bridge CBT-app op je telefoon of computer voor toegang tot volledige lesnotities, oefenvragen en meer.
Beschikbaar in de Green Bridge-app
Download de Green Bridge CBT-app op je telefoon of computer voor toegang tot volledige lesnotities, oefenvragen en meer.
Aanbevolen Boeken
Oefen Proefexamenvragen
Wilt u proefexamenvragen over Documentation oefenen? Download de Green Bridge CBT-app voor toegang tot proefexamenvragen en volledige oefentoetsen over dit onderwerp.
Download de app in de Google Playstore
Alles wat je nodig hebt om uit te blinken in JAMB, WAEC en NECO.
