Quickstart guide

Last updated

A quick start guide or quickstart guide (QSG) is in essence a shortened version of a manual, meant to make a buyer familiar with his or her product as soon as possible. This implies the use of a concise step-based approach that allows the buyer to use a product without any delay, if necessary including the relevant steps needed for installation. A quick start guide, or QSG for short, focuses on the most common instructions, often accompanying such instructions with easy-to-understand illustrations. [1] [2] The appearance of a QSG can vary significantly from product to product and from manufacturer to manufacturer. For example, it could be a single A4 sheet, a folded card or a booklet consisting of only a few pages. [1] [2]

Contents

A sample quick start guide for a radio Sample quick start guide (radio).jpg
A sample quick start guide for a radio

Background

Quick start guides are becoming more popular by the day, mainly because of the growing complexity of consumer products such as television sets, cell phones, cars and software applications. This growing complexity has led to manuals that are constantly growing in size, making them less attractive to read. [2] [3] A QSG should solve this problem: not only by focusing on the most basic instructions, but also by using visual information that is easy to understand. This approach should save time on the part of the user, giving him less stress while at the same time contributing to his self-confidence. [2] [3] As a result, users may conclude that using a product is not as difficult as they initially might have thought, hopefully leading to a growing willingness to tackle more complex tasks and, thus, exploring the product to the fullest of its extent. [2]

Relevance

When designing a QSG, the most important question is how to filter out the most basic instructions that are the most useful to the average user. [2] [3] The answer to this question primarily depends on two things: the ability of the QSG writer to place himself in the shoes of the user and the product itself. As for the latter: a product that basically only needs some instructions to install it properly after which it functions continuously, is relatively easy to ‘capture’ in a QSG. Also, products that offer a broad variety of tasks of which in reality only a few really matter, lend themselves for a QSG. [3] An example of such a product would be a software application. If the main tasks in such an application would be not more than a handful, then a QSG on a double-sided card could be an effective solution. If tasks would become more complicated of nature, one can refer to the complete manual.

Requirements

The requirements for setting up a quick start guide are not set in stone. It is up to the technical writer to become familiar with the mindset of the user, as well as with the character of the product. This being said, there is indeed a legal obligation, namely to refer to the complete manual (see the international IEC-82079 standard). Also, it is imperative to include instructions for safe use of the product in any QSG.

See also

Related Research Articles

Motorola 68000 Microprocessor

The Motorola 68000 is a 16/32-bit complex instruction set computer (CISC) microprocessor, introduced in 1979 by Motorola Semiconductor Products Sector.

Software documentation is written text or illustration that accompanies computer software or is embedded in the source code. The documentation either explains how the software operates or how to use it, and may mean different things to people in different roles.

End user Regular user of a product

In product development, an end user is a person who ultimately uses or is intended to ultimately use a product. The end user stands in contrast to users who support or maintain the product, such as sysops, system administrators, database administrators, information technology experts, software professionals and computer technicians. End users typically do not possess the technical understanding or skill of the product designers, a fact easily overlooked and forgotten by designers: leading to features creating low customer satisfaction. In information technology, end users are not "customers" in the usual sense—they are typically employees of the customer. For example, if a large retail corporation buys a software package for its employees to use, even though the large retail corporation was the "customer" which purchased the software, the end users are the employees of the company, who will use the software at work.

Usability Capacity of a system for its users to perform tasks

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

Data sheet Technical document summarizing performance and constraints of system components

A data sheet, data-sheet, or spec sheet is a document that summarizes the performance and other characteristics of a product, machine, component, material, subsystem, or software in sufficient detail that allows a buyer to understand what the product is and a design engineer to understand the role of the component in the overall system. Typically, a data sheet is created by the manufacturer and begins with an introductory page describing the rest of the document, followed by listings of specific characteristics, with further information on the connectivity of the devices. In cases where there is relevant source code to include, it is usually attached near the end of the document or separated into another file. Data sheets are created, stored, and distributed via product information management or product data management systems.

A technical writer is a professional information communicator whose task is to transfer information between two or more parties, through any medium that best facilitates the transfer and comprehension of the information. Technical writers research and create information through a variety of delivery media. Example types of information include online help, manuals, white papers, design specifications, project plans, and software test plans. With the rise of e-learning, technical writers are increasingly becoming involved with creating online training material.

Wizard (software)

A software wizard or setup assistant is a user interface type that presents a user with a sequence of dialog boxes that lead the user through a series of well-defined steps. Tasks that are complex, infrequently performed, or unfamiliar may be easier to perform using a wizard.

The Future Systems project (FS) was a research and development project undertaken in IBM in the early 1970s, aiming to develop a revolutionary line of computer products, including new software models which would simplify software development by exploiting modern powerful hardware.

Technical writing is writing or drafting technical communication used in technical and occupational fields, such as computer hardware and software, engineering, chemistry, aeronautics, robotics, finance, medical, consumer electronics, biotechnology, and forestry. Technical writing encompasses the largest sub-field in technical communication.

Technical communication is used to convey scientific, engineering, or other technical information. Individuals in a variety of contexts and with varied professional credentials engage in technical communication. Some individuals are designated as technical communicators or technical writers. These individuals use a set of methods to research, document, and present technical processes or products. Technical communicators may put the information they capture into paper documents, web pages, computer-based training, digitally stored text, audio, video, and other media. The Society for Technical Communication defines the field as any form of communication that focuses on technical or specialized topics, communicates specifically by using technology, or provides instructions on how to do something. More succinctly, the Institute of Scientific and Technical Communicators defines technical communication as factual communication, usually about products and services. The European Association for Technical Communication briefly defines technical communication as "the process of defining, creating and delivering information products for the safe, efficient and effective use of products ".

A user guide, also commonly known as a user manual, is intended to assist users in using a particular product, service or application. It's usually written by a technician, product developer, or a company's customer service staff.

Jazelle DBX is an extension that allows some ARM processors to execute Java bytecode in hardware as a third execution state alongside the existing ARM and Thumb modes. Jazelle functionality was specified in the ARMv5TEJ architecture and the first processor with Jazelle technology was the ARM926EJ-S. Jazelle is denoted by a "J" appended to the CPU name, except for post-v5 cores where it is required for architecture conformance.

User interface design Planned operator–machine interaction

User interface (UI) design or user interface engineering is the design of user interfaces for machines and software, such as computers, home appliances, mobile devices, and other electronic devices, with the focus on maximizing usability and the user experience. In computer or software design, user interface (UI) design is the process of building interfaces that are aesthetically pleasing. Designers aim to build interfaces that are easy and pleasant to use. UI design refers to graphical user interfaces and other forms of interface design. The goal of user interface design is to make the user's interaction as simple and efficient as possible, in terms of accomplishing user goals.

A software factory is a structured collection of related software assets that aids in producing computer software applications or software components according to specific, externally defined end-user requirements through an assembly process. A software factory applies manufacturing techniques and principles to software development to mimic the benefits of traditional manufacturing. Software factories are generally involved with outsourced software creation.

A power user is a user of computers, software and other electronic devices, who uses advanced features of computer hardware, operating systems, programs, or websites which are not used by the average user. A power user might not have extensive technical knowledge of the systems they use but is rather characterized by competence or desire to make the most intensive use of computer programs or systems.

Cypress PSoC Type of integrated circuit

PSoC is a family of microcontroller integrated circuits by Cypress Semiconductor. These chips include a CPU core and mixed-signal arrays of configurable integrated analog and digital peripherals.

Owners manual

An owner's manual is an instructional book or booklet that is supplied with almost all technologically advanced consumer products such as vehicles, home appliances and computer peripherals. Information contained in the owner's manual typically includes:

An API writer is a technical writer who writes documents that describe an application programming interface (API). The primary audience includes programmers, developers, system architects, and system designers.

XMC is a family of microcontroller ICs by Infineon. The XMC microcontrollers use the 32-bit RISC ARM processor cores from ARM Holdings, such as Cortex-M4F and Cortex-M0. XMC stands for "cross-market microcontrollers", meaning that this family can cover due to compatibility and configuration options, a wide range in industrial applications. The family supports three essential trends in the industry: It increases the energy efficiency of the systems, supports a variety of communication standards and reduces software complexity in the development of the application's software environment with the parallel released eclipse-based software tool DAVE.

SMART Process Acceleration Development Environment

SPADE is a software development productivity and quality tool used to create professional software in a short time and with little effort. As seen in the diagram SPADE automates many manual activities of the Software development process. It therefore takes less time and effort to perform the full software development cycle.

References

  1. 1 2 "Quick Reference Guide Formats: Tips for Finding Attractive Layouts." Dec 31, 2008.
  2. 1 2 3 4 5 6 "Quick Reference Guides: Short and Sweet Documentation." April 10, 2009.
  3. 1 2 3 4 "Quick Reference Guides: The Poetry of Technical Writing." July 6, 2008.
This page is based on this Wikipedia article
Text is available under the CC BY-SA 4.0 license; additional terms may apply.
Images, videos and audio are available under their respective licenses.