Documentation
Resumen
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.
Objetivos
- 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.
Nota de la lección
Disponible en la aplicación Green Bridge
Descarga la aplicación Green Bridge CBT en tu teléfono u ordenador para acceder a las notas completas, preguntas de práctica y más.
Evaluación de la lección
Felicitaciones por completar la lección del Documentation. Ahora que has explorado el conceptos e ideas clave, es hora de poner a prueba tus conocimientos. Esta sección ofrece una variedad de prácticas Preguntas diseñadas para reforzar su comprensión y ayudarle a evaluar su comprensión del material.
Te encontrarás con una variedad de tipos de preguntas, incluyendo preguntas de opción múltiple, preguntas de respuesta corta y preguntas de ensayo. Cada pregunta está cuidadosamente diseñada para evaluar diferentes aspectos de tu conocimiento y habilidades de pensamiento crítico.
Utiliza esta sección de evaluación como una oportunidad para reforzar tu comprensión del tema e identificar cualquier área en la que puedas necesitar un estudio adicional. No te desanimes por los desafíos que encuentres; en su lugar, míralos como oportunidades para el crecimiento y la mejora.
- 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 en la aplicación Green Bridge
Descarga la aplicación Green Bridge CBT en tu teléfono u ordenador para acceder a las notas completas, preguntas de práctica y más.
Disponible en la aplicación Green Bridge
Descarga la aplicación Green Bridge CBT en tu teléfono u ordenador para acceder a las notas completas, preguntas de práctica y más.
Libros Recomendados
Practica preguntas simuladas
¿Quieres practicar preguntas simuladas sobre Documentation? Descarga la aplicación Green Bridge CBT para acceder a preguntas simuladas y evaluaciones completas sobre este tema.
Descarga la aplicación en Google Playstore.
Todo lo que necesitas para destacar en JAMB, WAEC y NECO.
