Information and Communication Technology - 0417 CIE

Documentation

Gbogbo ọrọ náà

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.

Ebumnobi

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.

Akọmọ Ojú-ẹkọ

Documentation is what lets a system outlive the team that built it. Years later, a programmer who has never seen the system may need to fix a fault or add a feature, and a brand-new employee may need to learn the software from scratch. Neither can rely on asking the original developers. Good documentation, written while the system is fresh in everyone's mind, captures the knowledge they would otherwise lose, which is why it is a stage of the life cycle in its own right.

Ọ dị na ngwa Green Bridge

Budata ngwa Green Bridge CBT na ekwentị maọbụ kọmputa gị iji nweta akwụkwọ ndụmọdụ zuru oke, ajụjụ mmụta, na ndị ọzọ.

Akwụkwọ ndụmọdụ zuru oke nwere eserese

Onye inyeaka mmụta AI

Mụọ n'ụzọ na-enweghị ịntaneti, oge ọbụla, ebe ọbụla

Budata ngwa ekwentị Budata ngwa kọmputa

Ọ dị na Android, Windows, macOS, na Linux

Ayẹwo Ẹkọ

Ekele diri gi maka imecha ihe karịrị na Documentation. Ugbu a na ị na-enyochakwa isi echiche na echiche ndị dị mkpa, ọ bụ oge iji nwalee ihe ị ma. Ngwa a na-enye ụdị ajụjụ ọmụmụ dị iche iche emebere iji kwado nghọta gị wee nyere gị aka ịmata otú ị ghọtara ihe ndị a kụziri.

Ị ga-ahụ ngwakọta nke ụdị ajụjụ dị iche iche, gụnyere ajụjụ chọrọ ịhọrọ otu n’ime ọtụtụ azịza, ajụjụ chọrọ mkpirisi azịza, na ajụjụ ede ede. A na-arụpụta ajụjụ ọ bụla nke ọma iji nwalee akụkụ dị iche iche nke ihe ọmụma gị na nkà nke ịtụgharị uche.

Jiri akụkụ a nke nyocha ka ohere iji kụziere ihe ị matara banyere isiokwu ahụ ma chọpụta ebe ọ bụla ị nwere ike ịchọ ọmụmụ ihe ọzọ. Ekwela ka nsogbu ọ bụla ị na-eche ihu mee ka ị daa mba; kama, lee ha anya dị ka ohere maka ịzụlite onwe gị na imeziwanye.

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