Documentation
Aperçu
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.
Objectifs
- 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.
Note de cours
Disponible sur l'application Green Bridge
Téléchargez l'application Green Bridge CBT sur votre téléphone ou votre ordinateur pour accéder aux notes de cours complètes, aux questions pratiques, et plus encore.
Évaluation de la leçon
Félicitations, vous avez terminé la leçon sur Documentation. Maintenant que vous avez exploré le concepts et idées clés, il est temps de mettre vos connaissances à lépreuve. Cette section propose une variété de pratiques des questions conçues pour renforcer votre compréhension et vous aider à évaluer votre compréhension de la matière.
Vous rencontrerez un mélange de types de questions, y compris des questions à choix multiple, des questions à réponse courte et des questions de rédaction. Chaque question est soigneusement conçue pour évaluer différents aspects de vos connaissances et de vos compétences en pensée critique.
Utilisez cette section d'évaluation comme une occasion de renforcer votre compréhension du sujet et d'identifier les domaines où vous pourriez avoir besoin d'étudier davantage. Ne soyez pas découragé par les défis que vous rencontrez ; considérez-les plutôt comme des opportunités de croissance et d'amélioration.
- 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
Disponible sur l'application Green Bridge
Téléchargez l'application Green Bridge CBT sur votre téléphone ou votre ordinateur pour accéder aux notes de cours complètes, aux questions pratiques, et plus encore.
Disponible sur l'application Green Bridge
Téléchargez l'application Green Bridge CBT sur votre téléphone ou votre ordinateur pour accéder aux notes de cours complètes, aux questions pratiques, et plus encore.
Livres recommandés
Pratiquez des questions blanches
Vous voulez vous entraîner sur des questions blanches sur Documentation ? Téléchargez lapplication Green Bridge CBT pour accéder à des questions blanches et à des évaluations complètes sur ce sujet.
Téléchargez l'application sur Google Play.
Tout ce dont vous avez besoin pour exceller au JAMB, WAEC et NECO.
