Skip to content

Commit 258273a

Browse files
hugh+jetstreamgitbook-bot
hugh+jetstream
authored and
gitbook-bot
committed
GitBook: No commit message
1 parent 3d6d2d8 commit 258273a

16 files changed

+178
-0
lines changed

‎README.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# What is MyProduct?
2+
3+
{% hint style="info" %}
4+
**Good to know:** providing a brief overview of your product and its core use cases is a great place to start with product docs. Your product might seem obvious to you – you made it! However, to others, even folks who are trying your product after reading your site or getting a sales demo, it can still be unclear. This is your chance to clarify your product and set the right expectations!
5+
{% endhint %}
6+
7+
Here are a couple of examples of succinct overviews from products with really great docs:
8+
9+
> Loom is a video messaging tool that helps you get your message across through instantly shareable videos.
10+
>
11+
> With Loom, you can record your camera, microphone, and desktop simultaneously. Your video is then instantly available to share through Loom's patented technology.
12+
>
13+
> — From the [Loom Docs](https://support.loom.com/hc/en-us/articles/360002158057-What-is-Loom-)
14+
15+
> The Mailchimp Marketing API provides programmatic access to Mailchimp data and functionality, allowing developers to build custom features to do things like sync email activity and campaign analytics with their database, manage audiences and campaigns, and more.
16+
>
17+
> — From the [Mailchimp Marketing API docs](https://mailchimp.com/developer/marketing/docs/fundamentals/)
18+
19+
## Getting Started
20+
21+
**Got 2 minutes?** Check out a video overview of our product:
22+
23+
{% embed url="https://www.loom.com/share/3bfa83acc9fd41b7b98b803ba9197d90" %}
24+
25+
{% hint style="info" %}
26+
**Good to know:** A succinct video overview is a great way to introduce folks to your product. Embed a Loom, Vimeo or YouTube video and you're good to go! We love this video from the fine folks at [Loom](https://loom.com) as a perfect example of a succinct feature overview.
27+
{% endhint %}
28+
29+
### Guides: Jump right in
30+
31+
Follow our handy guides to get started on the basics as quickly as possible:
32+
33+
{% content-ref url="guides/creating-your-first-project.md" %}
34+
[creating-your-first-project.md](guides/creating-your-first-project.md)
35+
{% endcontent-ref %}
36+
37+
{% content-ref url="guides/creating-your-first-task.md" %}
38+
[creating-your-first-task.md](guides/creating-your-first-task.md)
39+
{% endcontent-ref %}
40+
41+
{% content-ref url="guides/advanced-permissions.md" %}
42+
[advanced-permissions.md](guides/advanced-permissions.md)
43+
{% endcontent-ref %}
44+
45+
{% hint style="info" %}
46+
**Good to know:** your product docs aren't just a reference of all your features! use them to encourage folks to perform certain actions and discover the value in your product.
47+
{% endhint %}
48+
49+
### Fundamentals: Dive a little deeper
50+
51+
Learn the fundamentals of MyProduct to get a deeper understanding of our main features:
52+
53+
{% content-ref url="fundamentals/projects.md" %}
54+
[projects.md](fundamentals/projects.md)
55+
{% endcontent-ref %}
56+
57+
{% content-ref url="fundamentals/members.md" %}
58+
[members.md](fundamentals/members.md)
59+
{% endcontent-ref %}
60+
61+
{% content-ref url="fundamentals/task-lists.md" %}
62+
[task-lists.md](fundamentals/task-lists.md)
63+
{% endcontent-ref %}
64+
65+
{% content-ref url="fundamentals/tasks.md" %}
66+
[tasks.md](fundamentals/tasks.md)
67+
{% endcontent-ref %}
68+
69+
{% hint style="info" %}
70+
**Good to know:** Splitting your product into fundamental concepts, objects, or areas can be a great way to let readers deep dive into the concepts that matter most to them. Combine guides with this approach to 'fundamentals' and you're well on your way to great documentation!
71+
{% endhint %}

‎SUMMARY.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Table of contents
2+
3+
* [What is MyProduct?](README.md)
4+
5+
## Guides
6+
7+
* [Creating your first project](guides/creating-your-first-project.md)
8+
* [Creating your first task](guides/creating-your-first-task.md)
9+
* [Advanced permissions](guides/advanced-permissions.md)
10+
11+
## Fundamentals
12+
13+
* [Projects](fundamentals/projects.md)
14+
* [Members](fundamentals/members.md)
15+
* [Task Lists](fundamentals/task-lists.md)
16+
* [Tasks](fundamentals/tasks.md)
17+
18+
## Use Cases
19+
20+
* [For Designers](use-cases/for-designers/README.md)
21+
* [Figma Integration](use-cases/for-designers/figma-integration.md)
22+
* [For Engineers](use-cases/for-engineers/README.md)
23+
* [GitHub Integration](use-cases/for-engineers/github-integration.md)
24+
* [For Support](use-cases/for-support/README.md)
25+
* [Intercom Integration](use-cases/for-support/intercom-integration.md)
26+
27+
## Extras
28+
29+
* [Keyboard Shortcuts](extras/keyboard-shortcuts.md)

‎extras/keyboard-shortcuts.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Keyboard Shortcuts
2+
3+
{% hint style="info" %}
4+
**Good to know:** depending on the product you're building, it can be useful to explicitly document use cases. Got a product that can be used by a bunch of people in different ways? Maybe consider splitting it out!
5+
{% endhint %}

‎fundamentals/members.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Members
2+
3+
{% hint style="info" %}
4+
**Good to know:** Splitting your product into fundamental concepts, objects, or areas can be a great way to let readers deep dive into the concepts that matter most to them.
5+
{% endhint %}

‎fundamentals/projects.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Projects
2+
3+
{% hint style="info" %}
4+
**Good to know:** Splitting your product into fundamental concepts, objects, or areas can be a great way to let readers deep dive into the concepts that matter most to them.
5+
{% endhint %}

‎fundamentals/task-lists.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Task Lists
2+
3+
{% hint style="info" %}
4+
**Good to know:** Splitting your product into fundamental concepts, objects, or areas can be a great way to let readers deep dive into the concepts that matter most to them.
5+
{% endhint %}

‎fundamentals/tasks.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Tasks
2+
3+
{% hint style="info" %}
4+
**Good to know:** Splitting your product into fundamental concepts, objects, or areas can be a great way to let readers deep dive into the concepts that matter most to them.
5+
{% endhint %}

‎guides/advanced-permissions.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Advanced permissions
2+
3+
{% hint style="info" %}
4+
**Good to know:** your product docs aren't just a reference of all your features! use them to encourage folks to perform certain actions and discover the value in your product.
5+
{% endhint %}

‎guides/creating-your-first-project.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Creating your first project
2+
3+
{% hint style="info" %}
4+
**Good to know:** your product docs aren't just a reference of all your features! use them to encourage folks to perform certain actions and discover the value in your product.
5+
{% endhint %}
6+
7+
## The basics
8+
9+
Projects are containers for task lists. Think of them as a library for everything your team needs to get done to complete or ship a project.
10+
11+
## Creating a project
12+
13+
Hit the big '+' button in your sidebar and select 'New Project' from the menu that pops up. Give your project a name, and you're good to go!

‎guides/creating-your-first-task.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Creating your first task
2+
3+
{% hint style="info" %}
4+
**Good to know:** your product docs aren't just a reference of all your features! use them to encourage folks to perform certain actions and discover the value in your product.
5+
{% endhint %}

‎use-cases/for-designers/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# For Designers
2+
3+
{% hint style="info" %}
4+
**Good to know:** depending on the product you're building, it can be useful to explicitly document use cases. Got a product that can be used by a bunch of people in different ways? Maybe consider splitting it out!
5+
{% endhint %}

‎use-cases/for-designers/figma-integration.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Figma Integration
2+
3+
{% hint style="info" %}
4+
**Good to know:** depending on the product you're building, it can be useful to explicitly document use cases. Got a product that can be used by a bunch of people in different ways? Maybe consider splitting it out!
5+
{% endhint %}

‎use-cases/for-engineers/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# For Engineers
2+
3+
{% hint style="info" %}
4+
**Good to know:** depending on the product you're building, it can be useful to explicitly document use cases. Got a product that can be used by a bunch of people in different ways? Maybe consider splitting it out!
5+
{% endhint %}

‎use-cases/for-engineers/github-integration.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# GitHub Integration
2+
3+
{% hint style="info" %}
4+
**Good to know:** depending on the product you're building, it can be useful to explicitly document use cases. Got a product that can be used by a bunch of people in different ways? Maybe consider splitting it out!
5+
{% endhint %}

‎use-cases/for-support/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# For Support
2+
3+
{% hint style="info" %}
4+
**Good to know:** depending on the product you're building, it can be useful to explicitly document use cases. Got a product that can be used by a bunch of people in different ways? Maybe consider splitting it out!
5+
{% endhint %}

‎use-cases/for-support/intercom-integration.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Intercom Integration
2+
3+
{% hint style="info" %}
4+
**Good to know:** depending on the product you're building, it can be useful to explicitly document use cases. Got a product that can be used by a bunch of people in different ways? Maybe consider splitting it out!
5+
{% endhint %}

0 commit comments

Comments
 (0)