6 Present Reelevant Information
6 Present Reelevant Information
MATERIAL
Talk to your trainer and agree on how you will both organize the
Training of this unit. The though the module carefully. It is divided
into section, which cover all the skills and knowledge you need to
successfully complete this module
Your trainer will tell you about the important things you need to
consider when you are completing activities and it is important
that you listen and take notes.
Use the self-check question at the end of each section to test your
own progress.
When you are ready, ask your trainer to watch you perform the
activities outlines in this module.
As you work through the activities, ask for written feedback on your
progress. Your trainer keeps feedback/pre assessment reports for this
reason. When you have successfully completed each
CBLM on Contact Date Developed: September Document No.
Tracing Level II 2020
Date Revised: Issued by:
Presenting Relevant
Information
Developed by: Date Revised: Page 2 of 175
Czarina Ruby M. Pedereche
element, ask your trainer to mark on the reports that you are ready
for assessment.
When you have complete this module (or several module), and fell
confident that you have had sufficient practice, your trainer will
arrange an appointment with registered assessor to assess you.
The result of your assessment will be recorded in your
Competency Achievement Record.
Participating in
1 Participate in workplace 400311210
workplace communication
communication
Working in team
2 Work in team 400311211
environment
environment
7 400311216
Practice Practicing
Occupational Occupational
safety and health safety and health
policies and policies and
CBLM on Contact Date Developed: September Document No.
Tracing Level II 2020
Date Revised: Issued by:
Presenting Relevant
Information
Developed by: Date Revised: Page 4 of 175
Czarina Ruby M. Pedereche
procedures procedures
Practice Practicing
9 entrepreneurial entrepreneurial 400311218
skills in the skills in the
workplace workplace
MODULE CONTENT
ASSESSMENT CRITERIA:
LEARNING
GATHER DATA/ INFORMATION
OUTCOME 1
ASSESSMENT CRITERIA
1. Evidence, facts and information are collected
2. Evaluation, terms of reference and conditions are reviewed to
determine whether data/information falls within project scope
CONDITIONS:
Writing materials
References
Manuals
Computer and Printer
Internet connectivity
METHODOLOGIES
Online learning
Offline learning
Group discussion
Lecture
Demonstration
ASSESSMENT METHODS:
Online/Virtual Assessment
Interview
Learning Outcome # 1
GATHER DATA/INFORMATION
INTRODUCTION
Traditionally among medical practitioners (doctors), the process at the very
beginning of care is termed as “clerking”. This consists of “history taking”
and “physical examination”. Other clinical care providers e.g. nurses use the
term ‘assessment’. It must be realized that this process is the start of a data
management cycle which consists of:
Clinicians (i.e. all professionals involved in direct patient care) are very
dependent on data already available to perform their work. Therefore, from
this perspective clinical care processes should be considered as a series of
data / information management activities. Being able to access to
accumulated data is indispensable because a large part of clinical processes
are cognitive (thinking) processes with data being the main input and
output.
Patient care is not just about treating the disease but the patient as a
whole. Therefore, there is a need to have sufficient information regarding the
patient to allow for special considerations to be made in making decisions,
implementation of management plans, communications and imparting
information.
Psycho-Social Status
The patient’s psycho-social status and level of education needs to be
gauged; because these will impact on his/her understanding of the illness
and its management. It would also make it easier for the care provider to
communicate with the patient and ensure that the patient accepts, complies
with and is satisfied with various aspects of care given.
A. Episodes,
B. Phases,
C. Visits,
D. Encounters
E. Events
Phases Of Care
The care episode can be divided into phases of the various care delivery
process. The phases can be categorized loosely into:
CHOICE OF METHODS
How and when data is gathered depends on the situation and type of case.
The sequence need not necessarily follow the standard clinical workflow
described above. Sometimes opportunities arise unplanned, e.g. a patient
describes something that the care provider intends to ask later or a sign of
another area is noticed when examining a certain area. However, the way
the data is presented need to follow a standard format so that information
can be easily sought and understood by everyone involved in the care of the
patient.
At the first encounter, the crucial reason for gathering data is to obtain
sufficient information to make a diagnosis and act upon it.
Content
The data regarding the patient includes:
The patient’s description of the sequence of events enables the care provider
to compare it with the natural history of a known disease. This will aid in
determining diagnosis, stage of the illness and its severity.
Objective Data
The care provider must attempt, to the utmost possible, to obtain objective
information through the use of more reliable methods such as physical
CBLM on Contact Date Developed: September Document No.
Tracing Level II 2020
Date Revised: Issued by:
Presenting Relevant Page 20 of
Information
Developed by: Date Revised: 175
Czarina Ruby M. Pedereche
examination (direct observation, palpation, auscultation etc.) and tests.
Usually, the diagnosis becomes increasingly more accurate as care
progresses as more objective data are obtained from monitoring and
investigations. Tests that give specific objective information regarding a
disease and used to clarify the diagnosis are called diagnostic
investigations.
1. Referral letters,
2. Notes / printouts of results and reports (Histopathology and Radiology
Report)
3. X-ray Films or Images in digital format
4. Case summary
5. Patient carried records
Information from these documents should be incorporated into the patient’s
history. It is also important to retain original hard copies or digital scanned
images of them.
By taking a clear history of the symptoms and the events surrounding it,
the clinician hopes to know the following:
Instead, it would be better to ask the patient directly “When did you first feel
unwell?” followed by “What make you think so?” Depending on the type of
symptom and acuteness of the onset the patient may give an exact time or
some vague period. The patient may even say he/she is healthy except for
the appearance of some swelling or mass or other changes in appearance
which is noticed either by himself or people around him.
Progress Of Symptoms
The occurrence of symptoms reflect the progress of the disease. A set of
symptoms may occur for a certain period and then abates before occurring
again at another period. Each period can be thought of as an episode of the
illness and the illness is said to be episodic or recurrent (note that the
disease episode is different from the care episode). Patients often do not
consider milder symptoms to be part of the same illness. It is likely that the
illness may have occurred earlier than the patient’s own estimation.
General/Systemic Symptoms
General symptoms are usually manifestations of the derangement of one or
more physiologic systems. It is expected even if the disease is in a specific
organ. Therefore, if symptoms expressed by the patient appear to be
confined to an organ or site, the general symptoms expected with the
pathological process or malfunctioning of the organ should be looked for.
Diseases originating from an organ may have spread or extended to the
surrounding region by the time the patient seeks help. The history becomes
the means for the clinician to ascertain the beginnings of the disease.
Method
Findings on examination are often referred to as signs. They can be either
discovered or elicited. The astute clinician uses all his/her senses of the
examiner (sight, touch, smell and hearing) with the exception, perhaps, of
taste.
Note that failure to find the signs do not disprove the hypothesis because
some effects of illness are especially at the early stage are subtle and may be
detected only by various laboratory-based tests, imaging techniques,
endoscopy or modalities. Repeat examination at a later time may prove to be
useful.
GENERAL EXAMINATION
In the general examination, the patient as a whole is assessed. It is used to
seek the following:
SYSTEMATIC REVIEW
Signs may be present even if the there is no related symptom. This may be
because the patient was unaware of it or would not divulge its presence.
There are also signs that appear before symptoms arise. An alert clinician
should be able to discover these signs as part of a systematic review. This
consists of examining each region and system in turn to discover anomalies.
It may not be detailed and exhaustive initially but may have to be repeated
later if the diagnosis remains unclear.
Hence, despite the postulate made after history taking the clinician needs to
have an open mind and consider all possibilities. The discovery of one or
more signs will lead to a different postulate and signs expected of that
postulate should be looked for. Indeed, the patient should be queried about
the presence of the sign and would often then recall symptoms or events he
or she had not mentioned earlier.
Colour
Surface appearance
Shape
CBLM on Contact Date Developed: September Document No.
Tracing Level II 2020
Date Revised: Issued by:
Presenting Relevant Page 29 of
Information
Developed by: Date Revised: 175
Czarina Ruby M. Pedereche
Rough Size
Abnormal or additional features not seen when the organ is normal (e.g.
discharge)
The clinician seeks for and describes the difference in these features from
that expected of a normal person. Both inspection and observation are best
done first without prior disturbance or interference. In children, this may be
best done when they are asleep or are distracted.
Observation
To observe is to look for changes in function and appearance of an organ or
body region over a time period. The functions that may be observed include:
Some functions are not evident by passive observation but can be made
apparent by instructing the patient to perform certain maneuvers. This
purposeful performance (e.g. movement) is said to be “active” function.
These are actually tests to demonstrate ability or disability of certain
functions (e.g. opening eyes and moving them side to side / up and down).
Palpation
Palpation is the use of tactile sensation of the fingers and hand to detect
characteristics that include:
1. Change in temperature
2. Surface texture
3. Shape
4. Contour or edge
5. Extent or size
6. Consistency
7. Mobility
8. Spontaneous movement of organs
9. Location, depth and relationships
Only signs in organs accessible to the fingers can be elicited. A gentle light
superficial palpation gives different information from deep palpation. A
knowledge of surface anatomy helps in determining the likely organs from
which the signs originate. The knowledge of cross-sectional anatomy help
indicate which anatomical layer the lesion is located i.e. within the skin,
subcutaneous tissue, the muscular layer, bones or body cavities. Certain
characteristics such as extent can be inferred when even when the whole
organ or mass cannot be reached based on the clinician’s knowledge of
anatomy or physiology.
In deep palpation the force exerted should not exceed that which would
cause discomfort to the patient and he/she should be forewarned. The
presence of tenderness should be anticipated and the presence of pain
should be asked for from the patient. Light palpation may be performed in
the presence of slight tenderness and the patient should be warned
regarding it. No further palpation or percussion should be done in the
presence of tenderness. The clinician will have to use other means such as
ultrasonogram or examination under anaesthesia to elicit the signs.
Test
General morphology
Specific finding
Location, extent
Characteristics
Specific function
Specific morphology
CBLM on Contact Date Developed: September Document No.
Tracing Level II 2020
Date Revised: Issued by:
Presenting Relevant Page 31 of
Information
Developed by: Date Revised: 175
Czarina Ruby M. Pedereche
The mass or swelling
Even when computerized forms may take on the form of empty pages, with
or without headings, where data can be typed in However, the use of
electronic forms for data acquisition allow for the structure to be more
definite and content to be more relevant. The use of structured data allow
for data aggregation, analysis and interpretation, features that can enable
the provision of decision support. This is further discussed in the article
on Clinical information System under the topic on data acquisition.
More complex forms can be structured such that documentation follows the
data gathering processes performed by the care provider. The data can be in
compartments arranged in a certain order applicable to history taking and
1. General morphology
2. Specific finding
a. surface appearance (colour, texture, breach of skin, discharges)
CBLM on Contact Date Developed: September Document No.
Tracing Level II 2020
Date Revised: Issued by:
Presenting Relevant Page 32 of
Information
Developed by: Date Revised: 175
Czarina Ruby M. Pedereche
b. tenderness,
c. presence of mass etc.).
For each of these, means of documenting expected characteristics can be
provided such as:
Location, extent
Specific function
Specific morphology
The mass or swelling
OBJECTIVE
Simple or requires use of instruments.
METHOD
choice
Protocols and procedures are the specific way that a policy, rule or principle
is carried out. It can often be thought of as a set of instructions. Procedures
can help small businesses to function productively by ensuring that
everyone executes tasks in the same way. It can be beneficial for
organizations to review their protocols and procedures on an annual basis to
ensure that they are up to date and reflect current business objectives.
Developing protocols and procedures is a matter of understanding the
company’s direction and goals.
Identify the policy or rule that needs a procedure attached to it. Clearly
understand the goal of the policy, such as if it is solving a problem,
increasing productivity, ensuring quality of a product or service, or if it is
preventing a potential conflict. Consider similar protocols that have been put
in place in the past and determine if they can be used as models for this
particular issue.
Test the protocol out. Distribute the instructions to a test group of three to
five people and have them put the procedure through a trial run. Ask them
to document any problems that they encounter while executing the protocol.
Have them make suggestions on ways to improve the instructions or
methods.
Review the test group’s findings and notice any problems or challenges with
the procedure. For example, the test group may have noticed that gridlock
will be created if your company purchases only one scanner since numerous
people will be using it. Amend the protocol as necessary.
Create a clean final document that outlines the protocol. Distribute the
document to the staff, or to the particular people whom it affects. Follow up
with the employees to make sure that the instructions are understandable.
1. Protocols and procedures are the specific way that a policy, rule or
principle is carried out.
2. Procedures can help small businesses to function productively by
ensuring that everyone executes tasks in the same way.
3. Procedures can not be beneficial for organizations to review their
protocols and procedures on an annual basis to ensure that they are
up to date and reflect current business objectives.
4. The last step in making a protocol is to identify the policy or rule that
needs a procedure attached to it.
5. Document the procedure in a step-by-step format
1. True
2. True
3. False
4. False
5. True
Importance of confidentiality
Confidentiality is important for several reasons. One of the most important
elements of confidentiality is that it helps to build and develop trust. It
potentially allows for the free flow of information between the client and
CBLM on Contact Date Developed: September Document No.
Tracing Level II 2020
Date Revised: Issued by:
Presenting Relevant Page 44 of
Information
Developed by: Date Revised: 175
Czarina Ruby M. Pedereche
worker and acknowledges that a client’s personal life and all the issues and
problems that they have belong to them.
One of the major purposes for obtaining a client’s consent before speaking to
a third party (such as another agency or a family member/carer) is to
protect the confidentiality and privacy of the client. Informed consent
(obtaining personal information with the formal permission of the client or a
person who has the legal authority to provide permission on behalf of the
client) is considered essential in maintaining the privacy of the client.
It is important to keep your clients’ business as just that – their business.
You should only discuss matters relating to your clients’ business with co-
workers, and then only what needs to be discussed. Discussions should
take place in the workplace and not be audible to other members of staff or
the general public. You should never discuss clients’ business with family or
friends.
Respect for client confidentiality and staff personal information should be a
high priority for all community services to comply with legislation that
governs disclosure of information. In this regard all organisations need to
have policies and procedures that provide guidelines for workers.
Appropriate worker behaviour can also be incorporated in a code of conduct.
To ensure confidentiality, workers should only access confidential
information for work that is covered by their job description and the policies
and procedures of the organisation. They should only disclose information to
other parties where a client (or co-worker in relation to their personal
information) has consented to the release of the information or where
disclosure is required or mandated by legislation due to indications of risk of
harm. Further workers need to ensure that any information that is collected
is securely stored and disposed of.
5. bank details
6. medical history or records
7. personal care issues
8. service records and file progress notes
9. individual personal plans
10. assessments or reports
11. guardianship orders
12. incoming or outgoing personal correspondence.
data values saved for a particular object, product, or service are accurate.
Any data you provide must be accurate, as this is what gives your business
Creating data values requires some discipline and absolute precision to make
sure all data values are accurate. Let’s delve deeper into why data accuracy
matters for your business and how it can contribute to growing your
profitability.
is an essential tool you can use to base your decisions on. This is how you’ll
Reduced costs — accurate and updated data helps you save money that
More importantly, current and accurate data about your consumers and
their buying and online habits help your marketing efforts by making
With the right timing, this helps you engage with the customers in a
personalized way and encourage them to come full circle in their customer
journey.
Time-saving — if you manage your data the right way, you reduce costs
and save time since you will not have to spend time rectifying your
Improved ROI — data accuracy demands data assets, and these assets
are nothing more than an investment. The more accurate your data is,
the greater the return on investment, and there are no additional costs.
Getting data management right is the only safe way of adopting the latest,
The more businesses use modern technology, the more data they generate.
All that data growth is nothing more than a lucrative opportunity you can
Since data is so essential, data accuracy becomes crucial for your business
success. The higher the quality, the bigger the chance there is to prosper.
business.
The highest data quality provides a certain level of confidence to all who
depend on that data. If data quality is high, the users will be able to produce
better outputs.
This increases business efficiency and lowers risk in the outcomes. With
2. Improved Productivity
The importance of data accuracy goes far beyond just decision-making. It’s
Accurate data makes the job of your employees much easier. Instead of
wasting time on finding and fixing data errors, your staff can shift their focus
Data errors are extremely costly for any business, but the risk is far greater
than just losing money. Aside from exhausting your financial resources, poor
efficiency.
In the worst-case scenario, your brand reputation will be ruined, and you’ll
lose most of your customers. The biggest problem with poor data is that one
you’ll have to spend that time fixing errors, which is a costly task.
Poor data also results in the inability to cope with the latest marketing
4. Improved Marketing
Nothing matters more than data accuracy for your marketing efforts and that
is why the importance of data accuracy cannot be undermined. High-quality
data allows you to market to the right audience, which reduces both time
and cost.
In return, sending the right message to the right audience means improving
more importantly, it allows you to keep your customers engaged with your
brand.
5. Aids in Compliance
evolving, and your business needs to evolve with them. The only way to do
2. Accurate and updated data helps you save money that would
tactics.
and their buying and online habits help your marketing efforts
4. If you manage your data the right way, you reduce costs and
save time since you will not have to spend time rectifying your
additional costs.
1. Increased revenue
2. Reduced costs
4. Time-saving
5. Improved ROI
1. Qualitative Analysis
This approach mainly answers questions such as ‘why,’ ‘what’ or ‘how.’ Each
of these questions is addressed via quantitative techniques such as
questionnaires, attitude scaling, standard outcomes, and more. Such kind
of analysis is usually in the form of texts and narratives, which might also
include audio and video representations.
2. Quantitative Analysis
Generally, this analysis is measured in terms of numbers. The data here
present themselves in terms of measurement scales and extend themselves
for more statistical manipulation.
The other techniques include:
3. Text analysis
Text analysis is a technique to analyze texts to extract machine-readable
facts. It aims to create structured data out of free and unstructured content.
The process consists of slicing and dicing heaps of unstructured,
heterogeneous files into easy-to-read, manage and interpret data pieces. It is
also known as text mining, text analytics, and information extraction.
The ambiguity of human languages is the biggest challenge of text analysis.
For example, the humans know that “Red Sox Tames Bull” refers to a
baseball match, but if this text is fed to a computer without background
knowledge, then it would generate several linguistically valid interpretations,
and sometimes people not interested in baseball might have trouble
understanding it too.
4. Statistical analysis
5. Diagnostic analysis
The diagnostic analysis is a step further to statistical analysis to provide
more in-depth analysis to answer the questions. It is also referred to as root
cause analysis as it includes processes like data discovery, mining and drill
down and drill through.
The diagnostic analysis is a step further to statistical analysis to provide
more in-depth analysis to answer the questions. It is also referred to as root
cause analysis as it includes processes like data discovery, mining and drill
down and drill through.
The functions of diagnostic analytics fall into three categories:
6. Predictive analysis
Predictive analysis uses historical data and feds it into the machine learning
model to find critical patterns and trends. The model is applied to the
current data to predict what would happen next. Many organizations prefer
it because of its various advantages like volume and type of data, faster and
cheaper computers, easy-to-use software, tighter economic conditions, and a
need for competitive differentiation.
The following are the common uses of predictive analysis:
CBLM on Contact Date Developed: September Document No.
Tracing Level II 2020
Date Revised: Issued by:
Presenting Relevant Page 59 of
Information
Developed by: Date Revised: 175
Czarina Ruby M. Pedereche
Fraud Detection: Multiple analytics methods improves pattern
detection and prevents criminal behavior.
Optimizing Marketing Campaigns: Predictive models help
businesses attract, retain, and grow their most profitable customers.
It also helps in determining customer responses or purchases,
promoting cross-sell opportunities.
Improving Operations: The use of predictive models also involves
forecasting inventory and managing resources. For example, airlines
use predictive models to set ticket prices.
Reducing Risk: Credit score that is used to assess a buyer’s
likelihood of default for purchases is generated by a predictive model
that incorporates all data relevant to a person’s creditworthiness.
Other risk-related uses include insurance claims and collections.
7. Prescriptive Analysis
Prescriptive analytics suggests various courses of action and outlines what
the potential implications could be reached after predictive analysis.
Prescriptive analysis generating automated decisions or recommendations
requires specific and unique algorithmic and clear direction from those
utilizing the analytical techniques.
2. Data Collection
3. Data Processing
o Organize your data and make sure to add side notes, if any.
o Cross-check data with reliable sources.
o Convert the data as per the scale of measurement you have
defined earlier.
o Exclude irrelevant data.
4. Data Analysis
Column Chart, Bar Chart: Both these charts are used to present
numerical differences between categories. The column chart takes to
the height of the columns to reflect the differences. Axes interchange
in the case of the bar chart.
Line Chart: This chart is used to represent the change of data over a
continuous interval of time.
Area Chart: This concept is based on the line chart. It additionally
fills the area between the polyline and the axis with color, thus
representing better trend information.
Pie Chart: It is used to represent the proportion of different
classifications. It is only suitable for only one series of data. However,
it can be made multi-layered to represent the proportion of data in
different categories.
Funnel Chart: This chart represents the proportion of each stage and
reflects the size of each module. It helps in comparing rankings.
Word Cloud Chart: It is a visual representation of text data. It
requires a large amount of data, and the degree of discrimination
needs to be high for users to perceive the most prominent one. It is
not a very accurate analytical technique.
Gantt Chart: It shows the actual timing and the progress of activity in
comparison to the requirements.
Radar Chart: It is used to compare multiple quantized charts. It
represents which variables in the data have higher values and which
have lower values. A radar chart is used for comparing classification
and series along with proportional representation.
Scatter Plot: It shows the distribution of variables in the form of
points over a rectangular coordinate system. The distribution in the
data points can reveal the correlation between the variables.
Bubble Chart: It is a variation of the scatter plot. Here, in addition to
the x and y coordinates, the area of the bubble represents the 3rd
value.
CBLM on Contact Date Developed: September Document No.
Tracing Level II 2020
Date Revised: Issued by:
Presenting Relevant Page 63 of
Information
Developed by: Date Revised: 175
Czarina Ruby M. Pedereche
Gauge: It is a kind of materialized chart. Here the scale represents the
metric, and the pointer represents the dimension. It is a suitable
technique to represent interval comparisons.
Frame Diagram: It is a visual representation of a hierarchy in the
form of an inverted tree structure.
Rectangular Tree Diagram: This technique is used to represent
hierarchical relationships but at the same level. It makes efficient use
of space and represents the proportion represented by each
rectangular area.
Map
o Regional Map: It uses color to represent value distribution over
a map partition.
o Point Map: It represents the geographical distribution of data in
the form of points on a geographical background. When the
points are the same in size, it becomes meaningless for single
data, but if the points are as a bubble, then it additionally
represents the size of the data in each region.
o Flow Map: It represents the relationship between an inflow area
and an outflow area. It represents a line connecting the
geometric centers of gravity of the spatial elements. The use of
dynamic flow lines helps reduce visual clutter.
o Heat Map: This represents the weight of each point in a
geographic area. The color here represents the density.
1. Excel
It has a variety of compelling features, and with additional plugins installed,
it can handle a massive amount of data. So, if you have data that does not
come near the significant data margin, then Excel can be a very versatile
tool for data analysis.
2. Tableau
It falls under the BI Tool category, made for the sole purpose of data
analysis. The essence of Tableau is the Pivot Table and Pivot Chart and
works towards representing data in the most user-friendly way. It
additionally has a data cleaning feature along with brilliant analytical
functions.
4. Fine Report
Fine Report comes with a straightforward drag and drops operation, which
helps to design various styles of reports and build a data decision analysis
system. It can directly connect to all kinds of databases, and its format is
similar to that of Excel. Additionally, it also provides a variety of dashboard
templates and several self-developed visual plug-in libraries.
5. R & Python
These are programming languages which are very powerful and flexible. R is
best at statistical analysis, such as normal distribution, cluster
classification algorithms, and regression analysis. It also performs individual
predictive analysis like customer behavior, his spend, items preferred by
him based on his browsing history, and more. It also involves concepts of
machine learning and artificial intelligence.
6. SAS
It is a programming language for data analytics and data manipulation,
which can easily access data from any source. SAS has introduced a broad
set of customer profiling products for web, social media, and marketing
analytics. It can predict their behaviors, manage, and optimize
communications.
Conclusion
This is a complete beginner guide about What is Data Analysis? Data
Analysis is the key to any business, whether it be starting up a new venture,
making marketing decisions, continuing with a particular course of action,
or going for a complete shut-down. The inferences and the statistical
probabilities calculated from data analysis help to base the most critical
decisions by ruling out all human bias. Different analytical tools have
overlapping functions and different limitations, but they are also
complementary tools. Before choosing a data analytical tool, it is essential to
take into account the scope of work, infrastructure limitations, economic
feasibility, and the final report to be prepared.
A document should never have more than one audience; that is, the only
audience a document should have is the group of people the document is
intended for. Good technical writing has to focus on its audience's needs. an
audience is a group of people with similar needs and similar levels of
technical and subject matter expertise and who will be using the document.
Finally, the auditors will review the requirements document to ensure the
requirements document meets the company's standards for requirements
documents (e.g., the requirements document contains all the information
about each requirement the company wants) and to ensure the system does
what the project team claims it does.
In the end, each audience determines exactly how they will use your
document. The project team uses the requirements document to tell them
what the system should do (the classic idea of a requirements document'
purpose). In addition, the requirements document often serves as the
linchpin for other documents, such as the design document, testing
documentation, and configuration management documentation.
The SMEs use the requirements document very differently than either the
project team or the departmental management. While the SME does provide
information about what the user needs, they also use the requirements
document to tell the user how the software will meet their needs. In this
way, the SME solicits feedback regarding the system and gains the user's
buy-in and thus provide an informal, if not a formal, review/approval of
system requirements documents to ensure they are complete.
The project team should have a high level of technical knowledge; otherwise,
they would not be creating the system. However, the team may not have
much knowledge of the subject matter area. Therefore, we must include
enough explanation, either in the requirement or in an introduction, to
ensure that the project team will understand how their system is expected to
perform the functions specified in the requirements. If the requirements
specify that the system should perform date searches, describing the valid
date range, the type of input, and what records to search will make the
requirement more easily designed and tested.
The SMEs have an in-depth knowledge of the subject, but have a limited
understanding of the computer technology to be used in the system.
Therefore, we must include a description and discussion of the technological
information so the SMEs will be able to evaluate and approve the solution
proposed and so they will be able to explain to the end users that the system
will meet their needs (and ideally be an improvement over their current
solution, if one exists). Many times all that is needed is reducing the amount
of "techie" jargon that is used and increasing the amount of "plain English."
1. A document should never have more than one audience; that is,
the only audience a document should have is the group of
people the document is intended for.
2. Contrary to popular opinion, the first question you must ask
yourself is not "What is the purpose of this document?"
3. The last question is "What does the audience need in this
document to use it?"
4. Now you can ask yourself "What information does each
audience in this document to use it?" The document must
provide sufficient information for the audience to use it.
5. the key to writing good technical documentation is meeting your
audience's needs, returning to these questions on each revision
of the document ensures that the document continues to
remain relevant to the project.
1. true
2. true
3. false
4. true
5. true