Manuals in Software Development
Uploaded by
ScribdTranslationsManuals in Software Development
Uploaded by
ScribdTranslationsManuals in software development
The documentation of programs is an extremely important aspect, both
in the development of the application as well as in its maintenance. Much
People do not do this part of the development and do not realize that they lose the
possibility of reusing part of the program in other applications, without
need to know the code by heart.
The documentation of a program begins at the same time as the construction of the
the same and ends just before the delivery of the program or application to the client. Thus
same, the documentation provided to the client must match with the
final version of the programs that make up the application.
Once the program is completed, the documents that must be submitted are a
technical guide, a user and installation guide.
Types of documentation
The documentation given to the client is clearly divided into two.
categories, internal and external:
Internal: It is one that is created in the same code, it can be in the form of comments.
or information files within the application.
External: It is that which is written in notebooks or books, completely unrelated to the application.
in itself. Within this category, electronic assistance is also included.
The technical guide
The technical guide or technical manual reflects the project's design, the
coding of the application and the tests carried out for its correctness
operation. Generally, this document is designed for people with
knowledge of computer science, generally programmers.
The main objective is to facilitate development, correction, and future
maintenance of the application in a quick and easy way.
This guide consists of three clearly differentiated sections:
Load notebook: It reflects the solution or design of the application.
This part of the guide is solely intended for programmers. It must be completed.
in such a way that allows for the division of labor
Source program: It is where the coding done by the programmers is included. This
The document may also have other documentation for better understanding and may
be of great help for the maintenance or improved development of the application. This
The document must have great clarity in its writing for easy understanding.
Tests: it is the document that specifies the type of tests carried out throughout
the entire project and the results obtained.
The user guide
It is what we commonly call the user manual. It contains the information
necessary for users to correctly use the application.
This document is made from the technical guide but the technical terms are omitted.
it is presented in a way that is understandable for the user who is not an expert in
computer science.
One point to consider in its creation is that it should not reference
no section of the technical guide and in the event that any is used
Technical terms should be accompanied by a glossary at the end for easy reference.
understanding.
The installation guide
It is the guide that contains the necessary information to implement it.
application.
Inside this document are the instructions for the implementation of
operation of the system and the rules for its use.
The usage regulations also include safety rules.
both the physical ones and those related to access to information.