diff --git a/content-types.mdx b/content-types.mdx index 83ebd60..dadd27a 100644 --- a/content-types.mdx +++ b/content-types.mdx @@ -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. +Person with floating blocks + Documentation needs to be organized around the specific goal you're trying to help the user achieve. ## Categorize using the Diataxis framework @@ -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. - - - + +Diataxis framework light mode +Diataxis framework dark mode ## Picking a type | Question | Tutorial | How-To | Reference | Explanation | diff --git a/images/audience.png b/images/audience.png new file mode 100644 index 0000000..9b7c81e Binary files /dev/null and b/images/audience.png differ diff --git a/images/diataxis.webp b/images/diataxis.webp deleted file mode 100644 index 2516257..0000000 Binary files a/images/diataxis.webp and /dev/null differ diff --git a/images/diataxis_dark.png b/images/diataxis_dark.png new file mode 100644 index 0000000..5687853 Binary files /dev/null and b/images/diataxis_dark.png differ diff --git a/images/diataxis_light.png b/images/diataxis_light.png new file mode 100644 index 0000000..7fc775f Binary files /dev/null and b/images/diataxis_light.png differ diff --git a/images/maintenance.png b/images/maintenance.png new file mode 100644 index 0000000..8ff61d0 Binary files /dev/null and b/images/maintenance.png differ diff --git a/images/media.png b/images/media.png new file mode 100644 index 0000000..d662243 Binary files /dev/null and b/images/media.png differ diff --git a/images/navigation.png b/images/navigation.png new file mode 100644 index 0000000..5e2dd66 Binary files /dev/null and b/images/navigation.png differ diff --git a/images/types.png b/images/types.png new file mode 100644 index 0000000..cfabae6 Binary files /dev/null and b/images/types.png differ diff --git a/know-your-audience.mdx b/know-your-audience.mdx index 03c439c..f57f9b6 100644 --- a/know-your-audience.mdx +++ b/know-your-audience.mdx @@ -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. +People walking around office buildings + ## 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. diff --git a/maintenance.mdx b/maintenance.mdx index 75c8d57..3e46623 100644 --- a/maintenance.mdx +++ b/maintenance.mdx @@ -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. +Giant gear + ### **Automate what you can** Documentation rot happens when you rely too much on manual effort to update content. diff --git a/media.mdx b/media.mdx index ecf6404..0e0f325 100644 --- a/media.mdx +++ b/media.mdx @@ -7,6 +7,12 @@ description: 'Guidelines for incorporating media' This article covers guidelines for how to use screenshots, GIFs, and videos in your documentation. +Stairs and a phone screen + Screenshots, GIFs, and videos can enhance documentation but require ongoing maintenance as UI elements change. Use them selectively to avoid unnecessary upkeep. Key guidelines: diff --git a/navigation.mdx b/navigation.mdx index f300505..b3da688 100644 --- a/navigation.mdx +++ b/navigation.mdx @@ -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. + +This article covers how to organize your information hierarchy in a way that makes sense for your users. + + +Hallway with trees ## Why is navigation important?