UX Writing Technical Specification API Docs Technical Documentation Knowledge Base Translation English Installation Guides Help Docs Troubleshooting Handbooks Support Docs Project Docs Portuguese Release Notes German SDK Product Discovery UX Design Spanish Copywriting Microcopy Educational Material Localization User Guides
// Describe the title of your article by replacing “Explanation template” with the page name you want to publish to.
= Explanation template // Article variables (delete the comments and add in the values) :description: Summarize what this explanation is about. What you put here is reused in the Overview section and included in HTML description tags. :keywords: // These are like labels Examples: {app}, explanation
== Overview
{description}
[glossary] == Glossary These terms are used throughout this article: //// Specify any definitions you need your audience to be aware of up-front. Remember: You may know what a term means, but your audience may not. //// term1:: description 1 term2:: description 2
’’’
== Explanation Topic
//// Begin your explanation topic in this section. For help with writing and structuring an explanation article, see the README.md in the template directory for basic guidelines and links. Check out https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/ if you get stuck with AsciiDoc syntax. ////