System documentation (system analysis and design)

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

1. S Y S T E M D O CUMENTATION H i m a n s h u D a n i I n tegrated M B A 3r d s e m e s ter

2. C O N T E N T S M e a n i ng o f S y s t em D o cumentation F e a t u res P u r p o s e T y p e s o f documentation I m p o r t a nce

3. S Y S T E M D O CUMENTATION 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).

4. 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.

5. F E A T U R E S 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

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

7. Purpose of System Documentation An overview of the entire project describing the general purpose of the system with the relevant information 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

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

9. T y p e s o f S y s t e m Document a t ion System Documentation User Documentation

10. T e c h n i c a l D o c u m entation 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.

11. 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.

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

13. U s e r D o c u m e n t a t i o n 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

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

15. 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.

16. u s e r v s t e c h n i c a l d o c umentation 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.

17. importance f o r 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

18. I m p o rtance f o r p r o g r a m m e r s 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 .