Product FeaturesLast updated: 07/02/2023

3.1 Feature Template

Use the template below for each core feature of your product or software. Not all sections are relevant all types of documentation and some sections could be generic for example system requirements or user permissions.

State the purpose of the feature from the user's perspective

Requirements

What is necessary to use the feature? (e.g. specific hardware or software, license, browser version)

Preparation

What has the user to do to get this new feature - e.g. add a special configuration setting, contact the vendor for beta-access

Getting started

Shortest way to use the new feature - short, specific - e.g. in how-to format

Description

Specific description using how-to guide or explanation for each of the main feature

Customization

How can the user adapt and customize the new feature?

Manage and setup

What and how can the administrator or power user configure the product to use the new features in the best way for the organization?

Reference and advanced learning

List of related documents the user can read to better understand and use the new feature, also already existing features and other product documentation types

Badges Examples:

Button Examples:

Progress Examples:

3.3 Ordered Lists Examples

Vivamus efficitur fringilla ullamcorper. Cras condimentum condimentum mauris, vitae facilisis leo. Aliquam sagittis purus nisi, at commodo augue convallis id.

Code Example: npm install <package>

Unordered List Examples:

• HTML5: <div id="foo">
• CSS: #foo { color: red }
• JavaScript: console.log('#foo\bar');

Ordered List Examples:

1. Download lorem ipsum dolor sit amet.
2. Click ipsum faucibus venenatis.
3. Configure fermentum malesuada nunc.
4. Deploy donec non ante libero.

Callout Examples:

Alert Examples:

3.4 Pagination

Vivamus efficitur fringilla ullamcorper. Cras condimentum condimentum mauris, vitae facilisis leo. Aliquam sagittis purus nisi, at commodo augue convallis id. Sed interdum turpis quis felis bibendum imperdiet. Mauris pellentesque urna eu leo gravida iaculis. In fringilla odio in felis ultricies porttitor. Donec at purus libero. Vestibulum libero orci, commodo nec arcu sit amet, commodo sollicitudin est. Vestibulum ultricies malesuada tempor.

Pagination Example:

Vivamus efficitur fringilla ullamcorper. Cras condimentum condimentum mauris, vitae facilisis leo. Aliquam sagittis purus nisi, at commodo augue convallis id. Sed interdum turpis quis felis bibendum imperdiet. Mauris pellentesque urna eu leo gravida iaculis. In fringilla odio in felis ultricies porttitor. Donec at purus libero. Vestibulum libero orci, commodo nec arcu sit amet, commodo sollicitudin est. Vestibulum ultricies malesuada tempor.

3.5 Table Types

Vivamus efficitur fringilla ullamcorper. Cras condimentum condimentum mauris, vitae facilisis leo. Aliquam sagittis purus nisi, at commodo augue convallis id. Sed interdum turpis quis felis bibendum imperdiet. Mauris pellentesque urna eu leo gravida iaculis. In fringilla odio in felis ultricies porttitor. Donec at purus libero. Vestibulum libero orci, commodo nec arcu sit amet, commodo sollicitudin est. Vestibulum ultricies malesuada tempor.

Lightbox Example:

The example below uses the simplelightbox plugin.

Custom Table:

Stripped Table:

Bordered Dark Table: