Documentation
Muhtasari
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.
Malengo
- 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.
Maelezo ya Somo
Inapatikana kwenye programu ya Green Bridge
Pakua programu ya Green Bridge CBT kwenye simu yako au kompyuta yako ili kupata maelezo kamili ya masomo, maswali ya mazoezi, na mengi zaidi.
Tathmini ya Somo
Hongera kwa kukamilisha somo la Documentation. Sasa kwa kuwa umechunguza dhana na mawazo muhimu, ni wakati wa kuweka ujuzi wako kwa mtihani. Sehemu hii inatoa mazoezi mbalimbali maswali yaliyoundwa ili kuimarisha uelewaji wako na kukusaidia kupima ufahamu wako wa nyenzo.
Utakutana na mchanganyiko wa aina mbalimbali za maswali, ikiwemo maswali ya kuchagua jibu sahihi, maswali ya majibu mafupi, na maswali ya insha. Kila swali limebuniwa kwa umakini ili kupima vipengele tofauti vya maarifa yako na ujuzi wa kufikiri kwa makini.
Tumia sehemu hii ya tathmini kama fursa ya kuimarisha uelewa wako wa mada na kubaini maeneo yoyote ambapo unaweza kuhitaji kusoma zaidi. Usikatishwe tamaa na changamoto zozote utakazokutana nazo; badala yake, zitazame kama fursa za kukua na kuboresha.
- 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
Inapatikana kwenye programu ya Green Bridge
Pakua programu ya Green Bridge CBT kwenye simu yako au kompyuta yako ili kupata maelezo kamili ya masomo, maswali ya mazoezi, na mengi zaidi.
Inapatikana kwenye programu ya Green Bridge
Pakua programu ya Green Bridge CBT kwenye simu yako au kompyuta yako ili kupata maelezo kamili ya masomo, maswali ya mazoezi, na mengi zaidi.
Vitabu Vinavyopendekezwa
Fanya Mazoezi ya Maswali ya Majaribio
Ungependa kufanya mazoezi ya maswali ya majaribio kuhusu Documentation? Pakua programu ya Green Bridge CBT ili kupata maswali ya majaribio na tathmini kamili za mazoezi kuhusu mada hii.
Pakua Programu Kwenye Google Playstore
Kila kitu unachohitaji ili kufaulu katika JAMB, WAEC & NECO.
