Document Template

A crisp, brief description of the document in one line.

Introduction

The document should have a light one paragraph introduction. Keep it simple, keep it clear. Some examples - https://www.framer.com/docs https://docs.gitbook.com/ https://www.figma.com/developers/docs#intro

Content

After the introduction has been covered, the article could cover whatever might be relevant. There are a few tools at the disposal of the writer. They are covered below.

Typography

Use of constant and hierarchical typography leads to better reading and consumption. Using different header types creates hierarchy within text while giving the document a clear outline. Use bold and italics sparingly but wisely. Example -

Typography leads to structural hierarchy

Tabs

Tabs can be used to create distinction between variants of the same information type. For example, tabs can be used to call attention to different kinds of platforms for the same product.

Web App

Covers a brief description of the web application.

Android App

Covers a brief description of the Android application.

iOS App

Covers a brief description of the iOS application.

Hints

Hints are great to call attention to important bite sized content. Examples -

Info: Used to call out important information.

Warning: Used to call out important warnings.

Danger: Used to call out important failure points.

Success: Used to call out important success points.

Quotes

Quotes can be used to capture juicy pieces of information.

The quick brown fox jumped over the lazy dog.

Other features

List of other features can be found here - https://docs.gitbook.com/content-editing/rich-content