Skip to content
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

added some images to the guide #10

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions content-types.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ description: 'Focus writing based on content type'
In this article, you’ll learn the different content types, when to use each one, and how to approach writing each type.
</Tip>

<img
src="/images/types.png"
alt="Person with floating blocks"
noZoom
/>

Documentation needs to be organized around the specific goal you're trying to help the user achieve.

## Categorize using the Diataxis framework
Expand All @@ -20,9 +26,19 @@ The [Diataxis framework](https://diataxis.fr) is a helpful guide for categorizin

Defining content types helps you plan documentation with a clear purpose and makes it easier for users to find what they need.

<Frame>
<img src="/images/diataxis.webp" />
</Frame>

<img
className="block dark:hidden"
src="/images/diataxis_light.png"
alt="Diataxis framework light mode"
noZoom
/>
<img
className="hidden dark:block"
src="/images/diataxis_dark.png"
alt="Diataxis framework dark mode"
noZoom
/>
## Picking a type

| Question | Tutorial | How-To | Reference | Explanation |
Expand Down
Binary file added images/audience.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/diataxis.webp
Binary file not shown.
Binary file added images/diataxis_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/diataxis_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/maintenance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/media.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/navigation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/types.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions know-your-audience.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ description: 'Keep user goals at the center of your writing'
This article covers how to identify your audience, conduct user research, and write with their needs in mind.
</Tip>

<img
src="/images/audience.png"
alt="People walking around office buildings"
noZoom
/>

## Identify your primary audience

Writing for multiple audiences leads to compromises that satisfy no one. Each piece of content should be laser-focused on one specific user persona.
Expand Down
6 changes: 6 additions & 0 deletions maintenance.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ description: 'Tips for keeping docs up-to-date'
This article covers strategies for keeping your documentation accurate and valuable over time, from automated checks to content lifecycles.
</Tip>

<img
src="/images/maintenance.png"
alt="Giant gear"
noZoom
/>

### **Automate what you can**

Documentation rot happens when you rely too much on manual effort to update content.
Expand Down
6 changes: 6 additions & 0 deletions media.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ description: 'Guidelines for incorporating media'
This article covers guidelines for how to use screenshots, GIFs, and videos in your documentation.
</Tip>

<img
src="/images/media.png"
alt="Stairs and a phone screen"
noZoom
/>

Screenshots, GIFs, and videos can enhance documentation but require ongoing maintenance as UI elements change. Use them selectively to avoid unnecessary upkeep.

Key guidelines:
Expand Down
11 changes: 9 additions & 2 deletions navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,15 @@
title: 'Organizing Navigation'
description: 'Guidelines for information hierarchy'
---

This article covers why and how to organize your information hierarchy in a way that makes sense for your users.
<Tip>
This article covers how to organize your information hierarchy in a way that makes sense for your users.
</Tip>

<img
src="/images/navigation.png"
alt="Hallway with trees"
noZoom
/>

## Why is navigation important?

Expand Down