Documentation
Bayani Gaba-gaba
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.
Manufura
- 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.
Takardar Darasi
Akwai a cikin manhajar Green Bridge
Zazzage manhajar Green Bridge CBT a wayar ka ko kwamfyuta ka don samun cikakkiyar bayanan darasi, tambayoyin aiki, da ƙari.
Nazarin Darasi
Barka da kammala darasi akan Documentation. Yanzu da kuka bincika mahimman raayoyi da raayoyi, lokaci yayi da zaku gwada ilimin ku. Wannan sashe yana ba da ayyuka iri-iri Tambayoyin da aka tsara don ƙarfafa fahimtar ku da kuma taimaka muku auna fahimtar ku game da kayan.
Za ka gamu da haɗe-haɗen nau'ikan tambayoyi, ciki har da tambayoyin zaɓi da yawa, tambayoyin gajeren amsa, da tambayoyin rubutu. Kowace tambaya an ƙirƙira ta da kyau don auna fannoni daban-daban na iliminka da ƙwarewar tunani mai zurfi.
Yi wannan ɓangaren na kimantawa a matsayin wata dama don ƙarfafa fahimtarka kan batun kuma don gano duk wani yanki da kake buƙatar ƙarin karatu. Kada ka yanke ƙauna da duk wani ƙalubale da ka fuskanta; maimakon haka, ka kallesu a matsayin damar haɓaka da ingantawa.
- 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
Akwai a cikin manhajar Green Bridge
Zazzage manhajar Green Bridge CBT a wayar ka ko kwamfyuta ka don samun cikakkiyar bayanan darasi, tambayoyin aiki, da ƙari.
Akwai a cikin manhajar Green Bridge
Zazzage manhajar Green Bridge CBT a wayar ka ko kwamfyuta ka don samun cikakkiyar bayanan darasi, tambayoyin aiki, da ƙari.
Littattafan da ake ba da shawarar karantawa
Yi Aikin Tambayoyin Gwaji
Kana son yin aikin tambayoyin gwaji kan Documentation? Sauke manhajar Green Bridge CBT don samun tambayoyin gwaji da cikakkun jarrabawa akan wannan batu.
Sauke Manhajar Daga Google Playstore
Duk abin da kake buƙata don yin fice a JAMB, WAEC & NECO.
