Online help in the context of "Documentation"

Play Trivia Questions online!

or

Skip to study material about Online help in the context of "Documentation"

Ad spacer

⭐ Core Definition: Online help

Online help is a form of user assistance that provides topic-oriented, procedural or reference information designed to assist in using a software application, web application or operating system. Online help linked to the application's state (what the user is doing) is called Context-sensitive help.

The help information can be created using help authoring tools or component content management systems and can be delivered in a wide variety of proprietary and open-standard formats. Help of this kind has largely replaced printed documentation.

↓ Menu

>>>PUT SHARE BUTTONS HERE<<<

👉 Online help in the context of Documentation

Documentation is any communicable material that is used to describe, explain or instruct regarding some attributes of an object, system or procedure, such as its parts, assembly, installation, maintenance, and use. As a form of knowledge management and knowledge organization, documentation can be provided on paper, online, or on digital or analog media, such as audio tape or CDs. Examples are user guides, white papers, online help, and quick-reference guides. Paper or hard-copy documentation has become less common. Documentation is often distributed via websites, software products, and other online applications.

Documentation as a set of instructional materials shouldn't be confused with documentation science, the study of the recording and retrieval of information.

↓ Explore More Topics
In this Dossier

Online help in the context of Usability

Usability or user friendliness can be described as the capacity of a system to provide a condition for its users to perform the tasks safely, effectively, and efficiently while enjoying the experience. In software engineering, usability is the degree to which a software can be used by specified consumers to achieve quantified objectives with effectiveness, efficiency, and satisfaction in a quantified context of use.

The object of use can be a software application, website, book, tool, machine, process, vehicle, or anything a human interacts with. A usability study may be conducted as a primary job function by a usability analyst or as a secondary job function by designers, technical writers, marketing personnel, and others. It is widely used in consumer electronics, communication, and knowledge transfer objects (such as a cookbook, a document or online help) and mechanical objects such as a door handle or a hammer.

↑ Return to Menu

Online help in the context of Technical writer

A technical writer is a professional communicator whose task is to convey complex information in simple terms to an audience of the general public or a very select group of readers. Technical writers research and create information through a variety of delivery media (electronic, printed, audio-visual, and even touch). In most organizations, a technical writer serves as a trained expert in technical writing and not as an expert in their field of employment. This, of course, does not mean technical writers aren't expected to have, at the very least, a basic understanding of their subject matter. Technical writers generally acquire necessary industry terminology and field or product knowledge on the job, through working with Subject-Matter Experts (SMEs) and their own internal document research.

In larger organizations, a technical writer often works as a member of a technical writing team, but may also work independently at smaller organizations and in select roles where workloads are focused. Examples of popular technical writing include online help, manuals, white papers, design specifications, project plans, and software test plans. With the rise of e-learning, technical writers are increasingly hired to develop online training material to assist users.

↑ Return to Menu