-
Notifications
You must be signed in to change notification settings - Fork 16
Add Notebooks documentation article & link to it in Quick Start Guide #123
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+226
−0
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,199 @@ | ||
| --- | ||
| title: A Practical Guide to Notebooks | ||
| tags: | ||
| - notebooks | ||
| - insights | ||
| - how-to | ||
| - features | ||
| description: Learn how to effectively use Notebooks to combine live charts and markdown text for better analytics insights and documentation. | ||
| lead: Notebooks combine live charts with your analytical thinking, helping you preserve context and momentum in your investigations. This guide shows you how to use them effectively, from basic setup to advanced techniques. | ||
| searchEngineTitle: How to Use TelemetryDeck Notebooks - A Practical Guide | ||
| searchEngineDescription: Learn how to effectively use TelemetryDeck Notebooks to combine live charts and markdown text for better analytics insights and documentation. | ||
| --- | ||
|
|
||
| ## Getting started with Notebooks | ||
|
|
||
| Notebooks are your analytics lab notebook – a place where you can document your findings, share insights with your team, and maintain context throughout your investigations. Let's explore how to use them effectively. | ||
|
|
||
| ### Creating your first notebook | ||
|
|
||
| 1. Open the Notebooks tab in your TelemetryDeck dashboard | ||
| 2. Click "Create New" | ||
| 3. Give it a clear, descriptive title | ||
| 4. Start writing your analysis using markdown | ||
|
|
||
| {% noteinfo "Start with a clear question" %} | ||
| Starting with a clear question or hypothesis helps focus your analysis and makes it easier to structure your notebook. It also makes it easier to share your findings with others later. | ||
| {% endnoteinfo %} | ||
|
|
||
|  | ||
|
|
||
| ### Adding charts to your notebook | ||
|
|
||
| The easiest way to add charts is using the "Copy TQL" button: | ||
|
|
||
| 1. Create your chart in the TelemetryDeck Dashboard | ||
| 2. Click the "Actions" menu | ||
| 3. Select "Copy TQL" | ||
| 4. In your notebook, create a code block marked as `tql` and paste the query: | ||
|
|
||
| ```markdown | ||
| ```tql | ||
| { | ||
| // Your chart's TQL query will be here | ||
| } | ||
| `` ` | ||
| ``` | ||
|
|
||
| {% noteinfo "Live TQL Editing" %} | ||
| You can modify a query right in your notebook – it will update live. This makes it easy to experiment with different visualizations and parameters. | ||
| {% endnoteinfo %} | ||
|
|
||
| You can customize how your data is displayed using the `displayMode` value in your TQL: | ||
| - `lineChart` - Perfect for trends over time | ||
| - `barChart` - Great for categorical comparisons | ||
| - `pieChart` - Best for proportional data | ||
| - `table` - Ideal for detailed breakdowns | ||
| - `funnel` - Essential for conversion analysis | ||
|
|
||
|  | ||
|
|
||
| ### Using Markdown effectively | ||
|
|
||
| Notebooks support all standard markdown features: | ||
|
|
||
| - **Headings** (`#`, `##`, etc.) – Structure your analysis into clear sections | ||
| - **Lists** (`-` or `1.`) – Break down steps, findings, or requirements | ||
| - **Code blocks** (```) – Share TQL queries or technical details | ||
| - **Images** (``) – Add screenshots or diagrams | ||
| - **Blockquotes** (`>`) – Highlight important insights or tips | ||
|
Check failure on line 69 in articles/notebooks.md
|
||
| - **Tables** – Compare data or list requirements | ||
|
|
||
| {% noteinfo "Adding Images to Notebooks" %} | ||
| For images, upload them to a service like Imgur or imgbb and use standard markdown image syntax. This is great for adding screenshots, diagrams, or any visual aids to your analysis. | ||
|
Check failure on line 73 in articles/notebooks.md
|
||
| {% endnoteinfo %} | ||
|
|
||
| ## Putting it all together: a real-world example | ||
|
|
||
| Now that we've covered the basics, let's see how notebooks work in practice. We'll walk through an example of analyzing an app's Onboarding flow, showing how notebooks help maintain context long-term. | ||
|
|
||
| ### Setting up the analysis | ||
|
|
||
| 1. **Define the Question** | ||
| ```markdown | ||
| # Onboarding flow analysis | ||
| Question: How well does our app convert installations into paying customers? | ||
| Hypothesis: The welcome window might be causing issues due to its similarity to Xcode's welcome screen. | ||
| ``` | ||
|
|
||
| 2. **Create the Funnel Chart** | ||
| - Use the dashboard to create a funnel chart | ||
| - Click "Copy TQL" to get the query | ||
| - Add it to your notebook with context: | ||
|
|
||
| ```markdown | ||
| ## User journey analysis | ||
| Let's track the complete user journey from installation to first successful value delivery: | ||
|
|
||
| <paste TQL here> | ||
| ``` | ||
|
|
||
| 3. **Document Findings** | ||
| ```markdown | ||
| ## Initial results | ||
| - 80% of users proceed past welcome screen | ||
| - 55% complete setup step ⚠️ | ||
| - 80% convert after setup | ||
|
|
||
| Key Insight: Welcome window isn't the problem. The real bottleneck is the setup step. | ||
| ``` | ||
|
|
||
| 4. **Plan Next Steps** | ||
| ```markdown | ||
| ## Next investigation | ||
| To understand why users drop off during setup, we need to track: | ||
| - [ ] `Onboarding.SetupStep.started` - When users begin the setup process | ||
| - [ ] `Onboarding.SetupStep.completed` - When users finish setup | ||
| - [ ] `Onboarding.SetupStep.abandoned` - When users leave without completing | ||
| - [ ] `Onboarding.SetupStep.duration` - How long users spend in setup | ||
| ``` | ||
|
|
||
| {% noteinfo "Preparing for Future Data" %} | ||
| You can already create insights using these parameters and copy their TQL into your notebook. When the tracking is implemented and data starts flowing, your charts will automatically update, letting you dive deeper immediately. | ||
| {% endnoteinfo %} | ||
|
|
||
| ### Maintaining context over time | ||
|
|
||
| The real power of notebooks becomes apparent during long-running investigations. As you wait for new data, your notebook serves as a living document that: | ||
|
|
||
| 1. **Preserves Your Thinking** – Document your hypotheses/assumptions | ||
| 2. **Tracks Progress** – Note what data you're waiting for and why | ||
| 3. **Prepares for Analysis** – Set up charts that will show data when it arrives | ||
| 4. **Shares Knowledge** – Help team members understand the context | ||
|
|
||
| This approach ensures you can pick up right where you left off when new data arrives, rather than starting from scratch. | ||
|
|
||
| ## Common use cases | ||
|
|
||
| Notebooks excel in several scenarios: | ||
|
|
||
| **Performance Investigation**: | ||
| When tracking down issues, combine error logs with performance metrics in one place. Document your hypotheses, track implementation progress, and update findings as new data arrives. | ||
|
|
||
| **Team Communication**: | ||
| Create weekly product health reports or onboard new team members by showing your notebooks. The combination of live charts and explanatory text makes it easy to convey complex insights. | ||
|
|
||
| **Feature Analysis**: | ||
| Compare user behavior across versions or track feature adoption over time. Notebooks help you maintain context throughout the analysis, from initial hypothesis to final implementation. | ||
|
|
||
| **Long-Running Investigations**: | ||
| Perhaps most importantly, notebooks help you maintain momentum during investigations that span weeks or months. Document what you're waiting for, prepare your analysis structure, and dive back in as soon as new data arrives. | ||
|
|
||
| Ready to level up your analytics workflow? Open the Notebooks tab and start exploring your data in a more structured, insightful way now! | ||
|
|
||
| ## Related resources | ||
|
|
||
| <div class="not-prose"> | ||
| <div class="my-6 grid grid-cols-1 gap-6 sm:grid-cols-2"> | ||
| <div class="group relative rounded-xl border bg-white border-slate-200 flex"> | ||
| <div class="absolute -inset-px rounded-xl border-2 border-transparent opacity-0 [background:linear-gradient(var(--quick-links-hover-bg,theme(colors.mars.50)),var(--quick-links-hover-bg,theme(colors.mars.100)))_padding-box,linear-gradient(to_top,theme(colors.mars.400),theme(colors.mars.500))_border-box] group-hover:opacity-100"></div> | ||
| <div class="shadow relative overflow-hidden rounded-xl p-6 h-full"> | ||
| <h2 class="font-semibold text-base text-mars-500"> | ||
| <a href="/docs/articles/insights"> | ||
| <span class="absolute -inset-px rounded-xl"></span>Understanding Insights</a> | ||
| </h2> | ||
| <p class="mt-1 text-sm text-slate-700">Learn how insights work and how to create effective visualizations for your notebooks.</p> | ||
| </div> | ||
| </div> | ||
| <div class="group relative rounded-xl border bg-white border-slate-200 flex"> | ||
| <div class="absolute -inset-px rounded-xl border-2 border-transparent opacity-0 [background:linear-gradient(var(--quick-links-hover-bg,theme(colors.mars.50)),var(--quick-links-hover-bg,theme(colors.mars.100)))_padding-box,linear-gradient(to_top,theme(colors.mars.400),theme(colors.mars.500))_border-box] group-hover:opacity-100"></div> | ||
| <div class="shadow relative overflow-hidden rounded-xl p-6 h-full"> | ||
| <h2 class="font-semibold text-base text-mars-500"> | ||
| <a href="/docs/tql/firstGuideline"> | ||
| <span class="absolute -inset-px rounded-xl"></span>TQL Query Language</a> | ||
| </h2> | ||
| <p class="mt-1 text-sm text-slate-700">Master the query language that powers notebook charts and enables advanced analytics.</p> | ||
| </div> | ||
| </div> | ||
| <div class="group relative rounded-xl border bg-white border-slate-200 flex"> | ||
| <div class="absolute -inset-px rounded-xl border-2 border-transparent opacity-0 [background:linear-gradient(var(--quick-links-hover-bg,theme(colors.mars.50)),var(--quick-links-hover-bg,theme(colors.mars.100)))_padding-box,linear-gradient(to_top,theme(colors.mars.400),theme(colors.mars.500))_border-box] group-hover:opacity-100"></div> | ||
| <div class="shadow relative overflow-hidden rounded-xl p-6 h-full"> | ||
| <h2 class="font-semibold text-base text-mars-500"> | ||
| <a href="/docs/articles/how-to-funnel-insights"> | ||
| <span class="absolute -inset-px rounded-xl"></span>Creating Funnel Charts</a> | ||
| </h2> | ||
| <p class="mt-1 text-sm text-slate-700">Learn how to track user conversion through multi-step processes – a key technique for notebook analyses.</p> | ||
| </div> | ||
| </div> | ||
| <div class="group relative rounded-xl border bg-white border-slate-200 flex"> | ||
| <div class="absolute -inset-px rounded-xl border-2 border-transparent opacity-0 [background:linear-gradient(var(--quick-links-hover-bg,theme(colors.mars.50)),var(--quick-links-hover-bg,theme(colors.mars.100)))_padding-box,linear-gradient(to_top,theme(colors.mars.400),theme(colors.mars.500))_border-box] group-hover:opacity-100"></div> | ||
| <div class="shadow relative overflow-hidden rounded-xl p-6 h-full"> | ||
| <h2 class="font-semibold text-base text-mars-500"> | ||
| <a href="/docs/guides/privacy-faq"> | ||
| <span class="absolute -inset-px rounded-xl"></span>Privacy FAQ</a> | ||
| </h2> | ||
| <p class="mt-1 text-sm text-slate-700">Understand how TelemetryDeck's privacy-first approach aligns with the data minimization strategy notebooks encourage.</p> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.