- Main characteristics of the instructions
- Structure
- 1. Introduction
- 2- Contact points
- 3- Primary business functions
- 4- Glossary
- 5- System or product capabilities
- 6- Description of functions
- 7- Preparation of input functions
- 8- Results
- 9- Operating instructions
- 10- Maintenance
- 11- Errors
- Examples of instructions
- 1- Instructions for assembling the chair
- Security
- Construction plan
- Diagrammer
- LTA calculator
- References
An instructional is a document that seeks to give some information about how to do something in particular. These texts serve as a guide for the individual to know the correct way to perform an action or to be informed about something.
Most of the instructions have a written guide or text with the instructions, plus some associated pictures (such as diagrams) that could help the individual understand the question.
The idea is that the instructions are written in a non-technical way so that they can be understood by the largest number of people.
The level of technical terminology and the level of content must be different than an expert guide, because the instructions must be aimed at the common citizen.
For this reason, it is important to define to whom the guide is directed; different readers will have different requirements.
Additionally, the instructions should have a structure that includes the cover, the introduction, the glossary, the general description and the instructions, among other elements.
As the name implies, the instructions are texts written to help people understand how to use a system.
Generally, the instructions are necessary when implementing a technological software system, assembling some furniture or instructions on how to use an electronic device.
The instructions should be the first item to be read when purchasing a new product.
By reading the instruction manual, many doubts about it can be resolved without having to require technical support or support from the manufacturer.
Main characteristics of the instructions
- Step-by-step instructions on using the product are included.
- They contain absolutely all the instructions for the product, in every possible way.
- They start with a quick one page user guide.
- They tell the user what the functions of the product are and what they are for, not just how to use those functions.
- They take into account the needs of disabled users (such as low vision or color blindness) and provide alternative instructions for these users, such as audio, braille or larger print.
- They use only one language.
- They have an effective use of color.
- Its pages are numbered and have an index.
- They have photos or diagrams that help to understand the product and the instructions.
- They use a clean and readable font; this means that they do not use serif fonts.
Structure
1. Introduction
It contains all the essential information for the user to use the entire system or product. This part should include a description of the functions of the system and its capabilities, contingencies and alternative modes of operation, step-by-step procedures and use.
If possible, use graphics. This section also provides a description of the purpose of the tutorial, its organization and possible references.
2- Contact points
This section identifies the organization and team codes that can assist the user. If there is any helpline or help desk, it is described in this section.
3- Primary business functions
This section includes the business perspective of the user's primary responsibilities with respect to the product or system.
4- Glossary
Here is the glossary of terms and abbreviations used in the instructions. If it is very long, more than a few pages, it is placed as an appendix.
5- System or product capabilities
This part provides a brief summary of the product's system and capabilities; its purpose must be described.
The idea is that the user understands the functions and operations of the system, including specific high-level functions. Graphs or tables should be included if appropriate.
6- Description of functions
Each specific function of the system is described. The following may be included:
- Purpose and use of the function. Relationships with other functions must also be added.
- Initialization of the function, if applicable.
- The execution options associated with the function and their description.
- Description of the expected inputs and their results.
7- Preparation of input functions
This section includes the inputs required for the system or product to function properly.
8- Results
The expected results of each function should also be included. These results should include graphics, text, and tables that can help the user. Additionally, examples are also placed.
9- Operating instructions
The list of processes related to the operating instructions is provided here. For example, it should contain the procedures to enter the system if applicable.
This initialization procedure should describe how to set the required mode of operation and how to start the parameters required to operate.
10- Maintenance
This section includes procedures to keep the system or product working properly.
11- Errors
This section should attend to any error message that could appear in the system or any possible malfunction of the equipment.
For example, you should include a list of all the error messages that may appear, what they mean, and how to fix them.
Examples of instructions
1- Instructions for assembling the chair
Security
Before using the tools, read, understand and follow the safety instructions for each one. If you don't understand, contact the manufacturer.
Protect your eyes with safety glasses, your ears with insulation, and your lungs with a respirator or mask.
Construction plan
Cut a 2x4x8 board of wood, four 1x3x1 boards, and three 5x3x2 boards.
Assemble the table according to the diagram and mark the joining points at the corners with a pencil. Then secure the pieces with a nail and hammer.
The rectangles represent the observed variables; fund variables are reflected as x.
The circles represent the latent variables and the arrows in the figures represent the relationships between the variables.
Special features include:
1- Individual or group analysis.
2- Stratification, selection probabilities, replicated weights and finite population corrections.
3- Maximum estimate for the types of results.
Diagrammer
It can be used to draw an input diagram. To enter this function, open the diagramming menu in the Mplus Editor. A set of drawing tools is used to make the diagram.
LTA calculator
Conditional probabilities are computed, including latent transition probabilities for different values. It can be used by choosing the LTA Calculator from the Mplus menu of the Mplus Editor.
References
- Manual guide. Recovered from statmodel.com
- Rookies guide to building furniture (2017). Recovered from sawsonskates.com
- Tips for writing user manuals. Recovered from userfocus.co.uk
- User guide. Recovered from wikipedia.org
- User guide tutorial. Recovered from klariti.com