diff --git a/know-your-audience.mdx b/know-your-audience.mdx index 03c439c..d4a48a4 100644 --- a/know-your-audience.mdx +++ b/know-your-audience.mdx @@ -17,7 +17,7 @@ Your audience might be: - End user relying on your product → may not be technical, looking to get started or how to do a specific task - Developer responsible for integrating your product → needs clear and concise instructions to get to their goals -Ahead of writing any page, ask yourself: what is my reader trying to accomplish (see [Content Types](/content_types)) and what is their prior knowledge? +Ahead of writing any page, ask yourself: what is my reader trying to accomplish (see [Content Types](/content-types)) and what is their prior knowledge? ## User research is key diff --git a/writing-style-tips.mdx b/writing-style-tips.mdx index cd96a88..a3cbe1f 100644 --- a/writing-style-tips.mdx +++ b/writing-style-tips.mdx @@ -24,7 +24,7 @@ description: 'Principles for style and tone' > > \- **CT Smith, Head of Docs at Payabli** -- **Don’t use product-centric terminology.** Your users don’t have the full context of your product (see [“Know Your Audience”](/know_your_audience)). Always orient language around the user’s familiarity with your product and what they’re trying to achieve. +- **Don’t use product-centric terminology.** Your users don’t have the full context of your product (see [“Know Your Audience”](/know-your-audience)). Always orient language around the user’s familiarity with your product and what they’re trying to achieve. - **Avoid “Duh” documentation.** Don’t tell users “Click Save to save.” Documentation should add value, not outline obvious steps. - **No colloquialisms.** Especially for localization, colloquialisms hurt clarity. @@ -36,4 +36,4 @@ Leverage existing style guides to standardize your documentation: - [Splunk Style Guide](https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Howtouse) - [Google Developer Documentation Style Guide](https://developers.google.com/style) -When you know which writing principles you want to implement, automate as much as you can. You can use linters (such as [Vale](https://vale.sh)) or your documentation provider, such as Mintlify’s [CI checks](https://mintlify.com/docs/settings/ci). \ No newline at end of file +When you know which writing principles you want to implement, automate as much as you can. You can use linters (such as [Vale](https://vale.sh)) or your documentation provider, such as Mintlify’s [CI checks](https://mintlify.com/docs/settings/ci).