Reader small image

You're reading from  Technical Writing for Software Developers

Product typeBook
Published inMar 2024
PublisherPackt
ISBN-139781835080405
Edition1st Edition
Right arrow
Author (1)
Chris Chinchilla
Chris Chinchilla
author image
Chris Chinchilla

Chris Chinchilla spent years as a developer before switching to helping people understand code better instead of writing it. He has worked crafting documentation for many developer-focused projects, from small open-source projects to large and well-known tools and products, tackling everything from tooling to videos. He is known for bringing developers and writers closer with editor and automation-based tools. Outside of tech writing, he publishes fiction, YouTube videos, podcasts, and music. In short, he loves to communicate and find the best medium for the message.
Read more about Chris Chinchilla

Right arrow

Getting started and onboarding

This content type helps people learn how to get started with a project or features.

Most inexperienced users start their journey with you via a Getting Started guide or onboarding experience. Getting Started, sometimes called a QuickStart, is typically a text-based guide that contains other media or interactive components.

Onboarding is sometimes called a tour or in-app help and is typically part of an app or product experience. It contains text that you might be involved in creating (I would say “should,” but that’s not always the case).

A detailed overview of Getting Started

I already covered some aspects of creating Getting Started guides in Chapter 1, but it’s a big topic, so the content you are likely to spend the most initial time on is worth covering in more detail. Whether you call it Getting Started, QuickStart, or onboarding, the first steps a user or potential user makes with a product are crucial.

...
lock icon
The rest of the page is locked
Previous PageNext Page
You have been reading a chapter from
Technical Writing for Software Developers
Published in: Mar 2024Publisher: PacktISBN-13: 9781835080405

Author (1)

author image
Chris Chinchilla

Chris Chinchilla spent years as a developer before switching to helping people understand code better instead of writing it. He has worked crafting documentation for many developer-focused projects, from small open-source projects to large and well-known tools and products, tackling everything from tooling to videos. He is known for bringing developers and writers closer with editor and automation-based tools. Outside of tech writing, he publishes fiction, YouTube videos, podcasts, and music. In short, he loves to communicate and find the best medium for the message.
Read more about Chris Chinchilla