This guide is designed for anyone responsible for writing documentation, but it isn’t their primary role. Developers, founders, customer success managers, product managers, and anyone else who wants their users to have high quality documentation.If you’re a technical writer, we would love to hear your thoughts on anything we’re missing in this guide! Drop us a line at hi@mintlify.com.
How was this guide written?
We interviewed and compiled insights from tenured technical writers with experience at companies like Stripe, Amplitude, Anaconda, and GitHub.We centered interviews on the most frequently asked questions from our customers about how to create best-in-class documentation.
How is this guide updated?
These principles are meant to be evergreen but we’re always open to feedback. If there is something you think we should change or add, let us know by opening an issue.
⌘I
{"docsConfig":{"theme":"willow","$schema":"https://mintlify.com/docs.json","name":"Mintlify Guides","colors":{"primary":"#0D9373","light":"#18E299","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/mintlify-guides/xrXznPBqmkzCq-oN/logo/light.svg?fit=max\u0026auto=format\u0026n=xrXznPBqmkzCq-oN\u0026q=85\u0026s=c9fd9ae38567041e79c3a49c6871e323","dark":"https://mintcdn.com/mintlify-guides/xrXznPBqmkzCq-oN/logo/dark.svg?fit=max\u0026auto=format\u0026n=xrXznPBqmkzCq-oN\u0026q=85\u0026s=57466ca7f8e96c801708c1a6899bff22"},"favicon":"https://mintcdn.com/mintlify-guides/xrXznPBqmkzCq-oN/favicon.svg?fit=max\u0026auto=format\u0026n=xrXznPBqmkzCq-oN\u0026q=85\u0026s=d52404d336792f16b2a4949125873975","navbar":{"primary":{"type":"github","href":"https://github.com/mintlify/guides"}},"footer":{"socials":{"x":"https://x.com/mintlify","github":"https://github.com/mintlify","linkedin":"https://linkedin.com/company/mintlify"}},"seo":{"metatags":{"og:image":"images/ogimage.png"}},"fonts":{"heading":{"family":"IBM Plex Sans"},"body":{"family":"IBM Plex Sans"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"mintlify-guides","hasAudioNarration":false,"actualSubdomain":"mintlify-guides","customDomains":["mintlify.com"],"gitSource":{"type":"github","owner":"mintlify","repo":"guides","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af7b38af41224aab41c439c","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Structure","count":3},{"language":"default","tag":"Writing","count":3},{"language":"default","tag":"Long-Term","count":2},{"language":"default","tag":"Overview","count":1}]},"assistantConfig":{},"basePath":"/guides","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":".dark\\:block,.block{img[src*=\"logo\"] {\n height: 2rem;\n }}img[src*=\"/logo/\"]{height:1.9rem!important}h1,h2,h3,h4,h5,h6{font-weight:500!important}.prose :where(img):not(:where([class~=not-prose],[class~=not-prose] *)){margin-top:0}.dark .chat-assistant-floating-input::before{background:rgb(var(--gray-900))}"}],"page":{"pagePath":"introduction","slug":"/introduction","pageMetadata":{"title":"Introduction","description":"Welcome to our compilation of best practices for writing technical documentation.","href":"/introduction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Welcome to our compilation of best practices for writing technical documentation.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Heading,Tip}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(`img`,{className:`mint-block dark:mint-hidden`,src:`https://mintcdn.com/mintlify-guides/xrXznPBqmkzCq-oN/images/intro-image-light.png?fit=max\u0026auto=format\u0026n=xrXznPBqmkzCq-oN\u0026q=85\u0026s=00b5ea4580f723e61255442425274d91`,alt:`Decorative image`,noZoom:true,\"data-og-width\":`2400`,width:`2400`,\"data-og-height\":`1260`,height:`1260`,\"data-path\":`images/intro-image-light.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/mintlify-guides/xrXznPBqmkzCq-oN/images/intro-image-light.png?w=280\u0026fit=max\u0026auto=format\u0026n=xrXznPBqmkzCq-oN\u0026q=85\u0026s=0218dbd839faffd373c9313d6c8cb6c6 280w, https://mintcdn.com/mintlify-guides/xrXznPBqmkzCq-oN/images/intro-image-light.png?w=560\u0026fit=max\u0026auto=format\u0026n=xrXznPBqmkzCq-oN\u0026q=85\u0026s=254f3692232415f76ff9d177146cfaff 560w, https://mintcdn.com/mintlify-guides/xrXznPBqmkzCq-oN/images/intro-image-light.png?w=840\u0026fit=max\u0026auto=format\u0026n=xrXznPBqmkzCq-oN\u0026q=85\u0026s=b8715716f21ea12bf99265f41f1c1a99 840w, https://mintcdn.com/mintlify-guides/xrXznPBqmkzCq-oN/images/intro-image-light.png?w=1100\u0026fit=max\u0026auto=format\u0026n=xrXznPBqmkzCq-oN\u0026q=85\u0026s=cc7adf49652095e2a8a35cc452ce6a46 1100w, https://mintcdn.com/mintlify-guides/xrXznPBqmkzCq-oN/images/intro-image-light.png?w=1650\u0026fit=max\u0026auto=format\u0026n=xrXznPBqmkzCq-oN\u0026q=85\u0026s=28390c833d3660a7d74b64f5eb37cb01 1650w, https://mintcdn.com/mintlify-guides/xrXznPBqmkzCq-oN/images/intro-image-light.png?w=2500\u0026fit=max\u0026auto=format\u0026n=xrXznPBqmkzCq-oN\u0026q=85\u0026s=aef649f2a8016dc950ffc1f3a6888177 2500w`}),`\n`,_jsx(`img`,{className:`mint-hidden dark:mint-block`,src:`https://mintcdn.com/mintlify-guides/xrXznPBqmkzCq-oN/images/intro-image-dark.png?fit=max\u0026auto=format\u0026n=xrXznPBqmkzCq-oN\u0026q=85\u0026s=252aac22b5493a906aeffa3f514df2bf`,alt:`Decorative image`,noZoom:true,\"data-og-width\":`2400`,width:`2400`,\"data-og-height\":`1260`,height:`1260`,\"data-path\":`images/intro-image-dark.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/mintlify-guides/xrXznPBqmkzCq-oN/images/intro-image-dark.png?w=280\u0026fit=max\u0026auto=format\u0026n=xrXznPBqmkzCq-oN\u0026q=85\u0026s=82495204460457b6d8579ee439bdf4b7 280w, https://mintcdn.com/mintlify-guides/xrXznPBqmkzCq-oN/images/intro-image-dark.png?w=560\u0026fit=max\u0026auto=format\u0026n=xrXznPBqmkzCq-oN\u0026q=85\u0026s=a287cbd21b50c10e838d5080e9f8497f 560w, https://mintcdn.com/mintlify-guides/xrXznPBqmkzCq-oN/images/intro-image-dark.png?w=840\u0026fit=max\u0026auto=format\u0026n=xrXznPBqmkzCq-oN\u0026q=85\u0026s=fc8f789dac8fd75c5b85fe846983d834 840w, https://mintcdn.com/mintlify-guides/xrXznPBqmkzCq-oN/images/intro-image-dark.png?w=1100\u0026fit=max\u0026auto=format\u0026n=xrXznPBqmkzCq-oN\u0026q=85\u0026s=80977c8a0a132435fe0136ea1636c21f 1100w, https://mintcdn.com/mintlify-guides/xrXznPBqmkzCq-oN/images/intro-image-dark.png?w=1650\u0026fit=max\u0026auto=format\u0026n=xrXznPBqmkzCq-oN\u0026q=85\u0026s=df78dda945d46331fcf71c0af373bb3c 1650w, https://mintcdn.com/mintlify-guides/xrXznPBqmkzCq-oN/images/intro-image-dark.png?w=2500\u0026fit=max\u0026auto=format\u0026n=xrXznPBqmkzCq-oN\u0026q=85\u0026s=62aedd914da1a01d1215569305b7f6d2 2500w`}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Special thank you to `,_jsx(_components.a,{href:`https://www.linkedin.com/in/skedwards88/`,children:`Sarah Edwards`}),`, `,_jsx(_components.a,{href:`https://www.linkedin.com/in/idan-englander/`,children:`Idan Englander`}),`, `,_jsx(_components.a,{href:`https://www.linkedin.com/in/brodyklapko/`,children:`Brody Klapko`}),`, `,_jsx(_components.a,{href:`https://www.linkedin.com/in/ethanpalm/`,children:`Ethan Palm`}),`, and `,_jsx(_components.a,{href:`https://www.linkedin.com/in/caseyrfowler/`,children:`CT Smith`}),` for sharing their knowledge for this guide!`]})}),`\n`,_jsx(Heading,{level:`2`,id:`who-is-this-guide-for`,children:`Who is this guide for?`}),`\n`,_jsx(_components.p,{children:`This guide is designed for anyone responsible for writing documentation, but it isn’t their primary role. Developers, founders, customer success managers, product managers, and anyone else who wants their users to have high quality documentation.`}),`\n`,_jsxs(_components.p,{children:[`If you’re a technical writer, we would love to hear your thoughts on anything we’re missing in this guide! Drop us a line at `,_jsx(_components.a,{href:`mailto:hi@mintlify.com`,children:`hi@mintlify.com`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`how-was-this-guide-written`,children:`How was this guide written?`}),`\n`,_jsx(_components.p,{children:`We interviewed and compiled insights from tenured technical writers with experience at companies like Stripe, Amplitude, Anaconda, and GitHub.`}),`\n`,_jsx(_components.p,{children:`We centered interviews on the most frequently asked questions from our customers about how to create best-in-class documentation.`}),`\n`,_jsx(Heading,{level:`2`,id:`how-is-this-guide-updated`,children:`How is this guide updated?`}),`\n`,_jsxs(_components.p,{children:[`These principles are meant to be evergreen but we’re always open to feedback. If there is something you think we should change or add, let us know by `,_jsx(_components.a,{href:`https://github.com/mintlify/guides/issues/new`,children:`opening an issue`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Introduction","description":"Welcome to our compilation of best practices for writing technical documentation.","href":"/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Who is this guide for?","slug":"who-is-this-guide-for","depth":2,"children":[]},{"title":"How was this guide written?","slug":"how-was-this-guide-written","depth":2,"children":[]},{"title":"How is this guide updated?","slug":"how-is-this-guide-updated","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"dynamicCss":".mint-block {\n display: block\n}\n.mint-hidden {\n display: none\n}\n.dark\\:mint-block:is(.dark *) {\n display: block\n}\n.dark\\:mint-hidden:is(.dark *) {\n display: none\n}","subdomain":"mintlify-guides","siteName":"Mintlify Guides","title":"Introduction - Mintlify Guides","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-12-19T01:42:59.922Z","originalFileLocation":"introduction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Welcome to our compilation of best practices for writing technical documentation.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Mintlify Guides\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/guides/mintlify-assets/_mintlify/favicons/mintlify-guides/QCkWVHawwmWxTpmJ/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/guides/mintlify-assets/_mintlify/favicons/mintlify-guides/QCkWVHawwmWxTpmJ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/guides/mintlify-assets/_mintlify/favicons/mintlify-guides/QCkWVHawwmWxTpmJ/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/guides/mintlify-assets/_mintlify/favicons/mintlify-guides/QCkWVHawwmWxTpmJ/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/guides/mintlify-assets/_mintlify/favicons/mintlify-guides/QCkWVHawwmWxTpmJ/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/guides/mintlify-assets/_mintlify/favicons/mintlify-guides/QCkWVHawwmWxTpmJ/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/guides/mintlify-assets/_mintlify/favicons/mintlify-guides/QCkWVHawwmWxTpmJ/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/guides/mintlify-assets/_mintlify/favicons/mintlify-guides/QCkWVHawwmWxTpmJ/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/guides/mintlify-assets/_mintlify/favicons/mintlify-guides/QCkWVHawwmWxTpmJ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Mintlify Guides\">\u003cmeta data-mint-head property=\"og:description\" content=\"Welcome to our compilation of best practices for writing technical documentation.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Mintlify Guides\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://mintlify.com/guides/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://mintlify-guides.mintlify.site/guides/images/ogimage.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Introduction - Mintlify Guides\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Welcome to our compilation of best practices for writing technical documentation.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://mintlify-guides.mintlify.site/guides/images/ogimage.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/guides/mintlify-assets/_mintlify/favicons/mintlify-guides/QCkWVHawwmWxTpmJ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Mintlify Guides\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://mintlify.com/guides/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/guides/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/guides/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://mintlify.com/#organization\",\"name\":\"Mintlify Guides\",\"url\":\"https://mintlify.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/mintlify-guides/xrXznPBqmkzCq-oN/logo/light.svg?fit=max\u0026auto=format\u0026n=xrXznPBqmkzCq-oN\u0026q=85\u0026s=c9fd9ae38567041e79c3a49c6871e323\"}},{\"@type\":\"WebSite\",\"@id\":\"https://mintlify.com/guides#website\",\"name\":\"Mintlify Guides\",\"url\":\"https://mintlify.com/guides\",\"publisher\":{\"@id\":\"https://mintlify.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://mintlify.com/guides/introduction#webpage\",\"url\":\"https://mintlify.com/guides/introduction\",\"name\":\"Introduction\",\"description\":\"Welcome to our compilation of best practices for writing technical documentation.\",\"dateModified\":\"2025-12-19T01:42:59.922Z\",\"isPartOf\":{\"@id\":\"https://mintlify.com/guides#website\"},\"breadcrumb\":{\"@id\":\"https://mintlify.com/guides/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://mintlify.com/guides/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Mintlify Guides\",\"item\":\"https://mintlify.com/guides\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://mintlify.com/guides/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://mintlify.com/guides/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"Welcome to our compilation of best practices for writing technical documentation.\",\"url\":\"https://mintlify.com/guides/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://mintlify.com/guides/introduction#webpage\"},\"image\":\"https://mintlify.com/guides/images/ogimage.png\",\"dateModified\":\"2025-12-19T01:42:59.922Z\",\"publisher\":{\"@id\":\"https://mintlify.com/#organization\"},\"isPartOf\":{\"@id\":\"https://mintlify.com/guides#website\"}}]}\u003c/script>","agentPointerHref":"/guides/introduction.md","siteName":"Mintlify Guides","nav":{"global":null,"groups":[{"group":"Overview","pages":[{"title":"Introduction","href":"/introduction"}]},{"group":"Structure","pages":[{"title":"Understand your audience","description":"Keep user goals at the center of your writing","href":"/know-your-audience"},{"title":"Content types","href":"/content-types"},{"title":"Organize navigation","href":"/navigation"}]},{"group":"Writing","pages":[{"title":"Style and tone","href":"/writing-style-tips"},{"title":"Using media","href":"/media"},{"title":"SEO","href":"/seo"}]},{"group":"Long-Term","pages":[{"title":"Maintenance","href":"/maintenance"},{"title":"Tracking success","href":"/success"}]}]},"basePath":"/guides","title":"Introduction - Mintlify Guides","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":[],"chunks":[]}
