Documentation
Akopọ
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.
Awọn Afojusun
- 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ọ̀wé Ẹ̀kọ́
O wa lori ohun elo Green Bridge
Gba ohun elo Green Bridge CBT sori foonu tabi kọmputa rẹ lati ri awọn akọsilẹ ẹkọ ni kikun, awọn ibeere adaṣe, ati diẹ sii.
Ìdánwò Ẹ̀kọ́
Oriire fun ipari ẹkọ lori Documentation. Ni bayi ti o ti ṣawari naa awọn imọran bọtini ati awọn imọran, o to akoko lati fi imọ rẹ si idanwo. Ẹka yii nfunni ni ọpọlọpọ awọn adaṣe awọn ibeere ti a ṣe lati fun oye rẹ lokun ati ṣe iranlọwọ fun ọ lati ṣe iwọn oye ohun elo naa.
Iwọ yoo pade adalu awọn iru ibeere, pẹlu awọn ibeere olumulo pupọ, awọn ibeere idahun kukuru, ati awọn ibeere iwe kikọ. Gbogbo ibeere kọọkan ni a ṣe pẹlu iṣaro lati ṣe ayẹwo awọn ẹya oriṣiriṣi ti imọ rẹ ati awọn ogbon ironu pataki.
Lo ise abala yii gege bi anfaani lati mu oye re lori koko-ọrọ naa lagbara ati lati ṣe idanimọ eyikeyi agbegbe ti o le nilo afikun ikẹkọ. Maṣe jẹ ki awọn italaya eyikeyi ti o ba pade da ọ lójú; dipo, wo wọn gẹgẹ bi awọn anfaani fun idagbasoke ati ilọsiwaju.
- 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
O wa lori ohun elo Green Bridge
Gba ohun elo Green Bridge CBT sori foonu tabi kọmputa rẹ lati ri awọn akọsilẹ ẹkọ ni kikun, awọn ibeere adaṣe, ati diẹ sii.
O wa lori ohun elo Green Bridge
Gba ohun elo Green Bridge CBT sori foonu tabi kọmputa rẹ lati ri awọn akọsilẹ ẹkọ ni kikun, awọn ibeere adaṣe, ati diẹ sii.
Awọn Iwe Itọsọna Ti a Gba Nimọran
Ṣe Adaṣe Awọn Ibeere Idanwo Adaṣe
Ṣe o fẹ ṣe adaṣe awọn ibeere idanwo adaṣe nipa Documentation? Ṣe igbasilẹ ohun elo Green Bridge CBT lati wọle si awọn ibeere idanwo adaṣe ati awọn ayẹwo adaṣe kikun fun koko-ọrọ yii.
Ṣe igbasilẹ ohun elo naa lori Google Playstore
Gbogbo ohun ti o nilo lati ṣe dara julọ ninu JAMB, WAEC ati NECO.
