User And Technical Documentation Essay

836 words - 3 pages

Generally, documentation is divided into two parts ? user documentation, and technical documentation.User documentation is generally provided to help the average computer user with a software programme or hardware installation. It might be instructional or tutorial style material, such as explaining how to do a particular bit of word processing, or how to write a programme using Visual Basic or Java. It may also be documentation to describe to a person how to install a piece of hardware such as a CD-ROM or CD burner, or how to connect up a modem to the Internet.Documentation can also be for training purposes, such as this document that you are currently reading, or the practical student workbooks that complement this theoretical data file.Generally, there are two ways that the information can be provided to a user ? in hard copy format, such as printed out, or in an on-line format. The choice of the format is increasingly towards on-line documentation, basically because it is a lot cheaper for the manufacturer, as the information does not have to be printed out, reproduced and bound together into a neat format. Rather it can be saved onto a floppy disk or CD-ROM, and mass-produced quite efficiently and cost-effectively. Usability is often a factor as well, though, as many users might prefer to have the information printed out and sitting in front of them so that they can flip through it in any order, skipping from one topic to another, rather than being restricted to having to go through a menu-type system. Also, with a paper-based document, it is easier to see what is contained within the document, whereas with the on-line help, it is difficult to know what topics are covered in the document.Increasingly nowadays, documentation is not only on-line, but Internet based and hypertext-enabled, so that the user can jump from topic to topic by clicking on hypertext, and even jumping to an Internet site to view documentation as required. This is fine as long as the user has a live Internet connection, but can be costly, time-consuming and frustrating if you have to dial up to your ISP (paying call costs and usage costs) each time you want to find out how to do something for a piece of commercial software that you have paid a reasonable amount of money for.Technical documentation is available for systems engineers, network administrators and technicians who need to know how the system was built,...

Find Another Essay On User And Technical Documentation

Help Desk Essay

1079 words - 4 pages maintain the efficiency and lean attitude that creates a global awareness among the organization. By reducing the technical gaps among the skills of an organizational and inducting a collaborative real time social solution a learning organization can create the tactical mindset that the user is capable of solving issues with minimal or zero assistance from support personal. In this mindset the relationship fostered by agile growth and modulated

Why Software Fails? Essay

924 words - 4 pages Testing : When the pressure to deliver is on, it is often testing that suffers. All the testing is left until the end of the development cycle and only lip service paid to it. Often, the result is a product filled with bugs and an unhappy customer. V. Bad or No Documentation : Documentation should be considered as a "must have" and not "nice to have". Documentation is an integral part of developing the life cycle process. It should not be caught as a

why software fails?

924 words - 4 pages Testing : When the pressure to deliver is on, it is often testing that suffers. All the testing is left until the end of the development cycle and only lip service paid to it. Often, the result is a product filled with bugs and an unhappy customer. V. Bad or No Documentation : Documentation should be considered as a "must have" and not "nice to have". Documentation is an integral part of developing the life cycle process. It should not be caught as a

Windows Xp Architecture Vs. Mac Os X Architecture

1180 words - 5 pages (the User Interface) and the Finder application. The Aqua interface is the graphical user interface, it uses soft edges, translucent colors, more color and texture to the windows and it controls most of the systems overall appearance. Apple made this decision during a time that most user interfaces were seen as dull and boring. The Finder is a subset of the user interface as it helps navigate through the system and the finder isn't required to

Systems Analysis-Lifecycle Models and Methodologies

2598 words - 10 pages has chosen is documented in full detail. An examination of the input and output can be examined. There must be full agreement between the analyst team and the user before further progress is made.The next stage is the logical system specification. The physical implementation of the required system is addressed at this stage. A number of technical options are created specifying languages, packages and implementation platform. An option is then

Lifecycle Models and Methodologies

2588 words - 10 pages detail. An examination of the input and output can be examined. There must be full agreement between the analyst team and the user before further progress is made.The next stage is the logical system specification. The physical implementation of the required system is addressed at this stage. A number of technical options are created specifying languages, packages and implementation platform. An option is then selected on the basis of performance

Lifecycle models and methodologies

2590 words - 10 pages detail. An examination of the input and output can be examined. There must be full agreement between the analyst team and the user before further progress is made.The next stage is the logical system specification. The physical implementation of the required system is addressed at this stage. A number of technical options are created specifying languages, packages and implementation platform. An option is then selected on the basis of

types of software methodology

1164 words - 5 pages (Hodges, 2007). The basic principles are the project is divided into sequential phases, with some overlap and splash back acceptable between phases. Planning, time schedules, target dates, budgets and implementation of an entire system at one time is then emphasis. Furthermore, through the use of detail written document and approval by the user and information technology management, the life of the project is maintained with tight control at the

sr-mr-022

1582 words - 6 pages -technical staff, it would be advisable to take a task-oriented approach to the documentation process. This would mean that the documentation would solely focus on describing individual commands as applied within the system and their implication to both end-users and system administrators (Satzinger, Jackson, & Burd, 2008). User documentation would therefore include instructions on how to get started with the system, as well as explaining the precise

Requirements Specification Plan for a Computer System

2390 words - 10 pages about the Project 6 3. Requirements Specification 6 3.1 General Requirements 7 3.2 Functional Requirements 7 4. Administrative and Installation Requirements 11 4.1 Administrative Requirements 11 4.2 Installation Requirements 11 5. Technical Requirements 12 6. Revision History 13   1. Introduction to Document In accordance with the M-FILES Validation Master Plan (VMP), this USER Requirements Specification (URS) defines the user requirement M

Student Information System Request For Proposal

3003 words - 12 pages on-going basis as required. The vendor shall provide hands-on training to system administrators and "power users." Provide a detailed description of your firm's training plan.Provided with the implemented application shall be extensive documentation identifying end-user step-by-step procedures for completing tasks and activities, as well as technical documentation.Installation IssuesPlease provide a plan for the implementation of the student

Similar Essays

The Entertainment Fields Essay

2616 words - 10 pages certain game documentation: In short, what goes into the game and what it does is documented in the functional specification [documentation]. This is often writen from the perspective of the user. How it is implemented and how it performs the function is docume nted in the technical specification [documentation]. This is often writen from the system perspective. Both form important deliverable milestones in the design stage of the game development

Implementation System Development Lifecycle Essay

1184 words - 5 pages testing of the system’s components as well as the delivery of the system into production. The objective of system implementation is to construct a system, install it, replace the old system, prepare the new system, and create user documentation, train users, and post implementation evaluation of results. During this phase, it’s also involves a closedown the entire project. Before the closedown and changeover occurs, the system must be tested

• Describe In Detail What Is Meant By The Term “Service Oriented Architecture” And Discuss What Challenges It Presents To A Systems Developer

613 words - 3 pages hardware configuration. Horizontal scalability, High availability can also be achieved with ease. Organizations determine, what business processes can be built as a service by analyzing repeatable functionalities, patterns that span across different applications. To give a simple overview, consider a scenario where an organization having multiple applications, that on completion of a process or an event, notifies the end user via email, SMS and

Challenges In Agile Global Software Development

1009 words - 5 pages documentation because of the nature of the distrubuted development is indicated. This situation is against to less documentation principle of Agile software development methodology. The third category emphasizes inefficiency of remote conferences. It is indicated that video conferences usually lead team members to spent much more time to solve technical problems. It can be distracting and useless when combined with poor audio and video quality. 5.4