Documentation
Visão Geral
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 Aula
Disponível na aplicação Green Bridge
Transfira a aplicação Green Bridge CBT para o seu telemóvel ou computador para aceder a notas de aula completas, questões de prática e muito mais.
Avaliação da Lição
Parabéns por concluir a lição em Documentation. Agora que você explorou o conceitos e ideias-chave, é hora de colocar seu conhecimento à prova. Esta seção oferece uma variedade de práticas perguntas destinadas a reforçar sua compreensão e ajudá-lo a avaliar sua compreensão do material.
Irá encontrar uma mistura de tipos de perguntas, incluindo perguntas de escolha múltipla, perguntas de resposta curta e perguntas de redação. Cada pergunta é cuidadosamente elaborada para avaliar diferentes aspetos do seu conhecimento e competências de pensamento crítico.
Use esta secção de avaliação como uma oportunidade para reforçar a tua compreensão do tema e identificar quaisquer áreas onde possas precisar de estudo adicional. Não te deixes desencorajar pelos desafios que encontrares; em vez disso, vê-os como oportunidades de crescimento e melhoria.
- 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
Disponível na aplicação Green Bridge
Transfira a aplicação Green Bridge CBT para o seu telemóvel ou computador para aceder a notas de aula completas, questões de prática e muito mais.
Disponível na aplicação Green Bridge
Transfira a aplicação Green Bridge CBT para o seu telemóvel ou computador para aceder a notas de aula completas, questões de prática e muito mais.
Livros Recomendados
Pratique Questões Simuladas
Quer praticar questões simuladas sobre Documentation? Descarregue a aplicação Green Bridge CBT para aceder a questões simuladas e avaliações completas sobre este tópico.
Descarregar a aplicação na Google Play Store
Tudo o que precisas para te destacares no JAMB, WAEC e NECO.
