system analysis and design topic - software documentation #softwaredevelopment #softwaredocumentation #systemanalysisanddesign

1. SYSTEM
DOCUMENTATION
Himanshu Dani
Integrated MBA 3rd semester

2. CONTENTS
Meaning of System Documentation
Features
Purpose
Types of documentation
Importance

4. SYSTEM
DOCUMENTATION
In computer hardware and software
product development, documentation is
the information that describes the product
to its users. It consists of the product
technical manuals and online information
(including online versions of the technical
manuals and help facility descriptions).

5. Documentation is now often built directly
into the product as part of the user
interface and in help pages. Printed
technical manuals are increasingly available
at company Web sites in the form of Adobe
Acrobat Portable Document Format (PDF)
files or in HTML pages. IBM and Microsoft
are among the world's largest publishers.

6. FEATURES
• It must be clearly stated in the language
that is easily understood
• It should be possible to refer to other
documents
• It should be possible to refer to other
documents

7. • When the system gets modified it should be
easy to update the documentation
• It should be accessible to those for whom
it is intended.

8. Purpose of System
Documentation
1. An overview of the entire project describing the
general purpose of the system with the relevant
information
2. Documentation for every input and output used in
the system. Each document should accompany each
design and explain the purpose and use of each form

9. 1. Documentation of every file of the system, creating and
update sequences of the file should be there
2. System flowchart describing the series of steps used in
the processing of data
3. A financial analysis of the proposed and existing systems,
providing present and future costs with potential cost
savings
4. A description of the computer system and its peripheral
equipment’s

10. Types of System
Documentation
1. System Documentation
2. User Documentation

11. Technical
Documentation
The technical documentation term refers to
different documents which contain product-related
data and information that will be helpful for users.
Technical documentation contains product
definition and specification, quality assurance,
manufacturing, description of features and
functions, maintenance information, and more.

12. The goal of technical documentation is to
provide enough information for a user to
understand the inner and outer dependencies
of the product at hand. It also helps users:
Troubleshoot their issues.
Find the best ways to use a product.
Learn the product from scratch and more.

13. Technical documentation is not just
manuals, it also includes science papers,
research, reports, white papers, case
studies and the like.

14. User
Documentation
User documentation is created for end-
users on using a product. The main goal
of user documentation is to assist the
end-users by providing them with clear
and comprehensible info about the
particular product or service

15. User documentation comprises:
Support Portals
FAQs
Video tutorials
Step-by-step guides
Embedded assistance

16. Tech writers describe the following aspects in
user documentation:
Software requirements.
Installation guide.
How to start the system.
How to use features of a product.
Screenshots explaining those features.
Contacts of the developer if an
undocumented question arises and more.

17. user vs technical
documentation
 Technical documentation is a broader term than user
documentation.
 Technical documentation can be internal
and external, while user documentation is always
created for end-user.
 The process of creating user documentation requires
a minimum technical background compared with
technical documentation.

18. importance for user's
The user documentation is designed to
assist end users to use the product or
service. This is often referred to as user
assistance. The user documentation is a
part of the overall product delivered to
the customer. Traditionally user
documentation was provided as a user
guide, instruction manual or online help

19. Importance for
programmers
For a programmer reliable documentation is
always a must. The presence of
documentation helps keep track of all
aspects of an application and it improves on
the quality of a software product. Its main
focuses are development, maintenance and
knowledge transfer to other developers.