Experience League Authoring Guide
Please note, this content is intended only for Adobe employees. If you are not an Adobe employee, see the Adobe Contributor Guide.
Searchable list of articles
TIP
We’re still working on allowing this guide to be searched in experienceleague.adobe.com without making it public. In the meantime, you can search within this page to find the article for which you’re looking.
Article
Description and Keywords
Find syntax guidance. Contact Bob Bringhurst with questions.
Find editorial guidance. Contact Blake Frei with questions.
List of new articles and significant changes.
Learn how to author and publish Experience League content.
How Adobe contributors should set up Git, GitHub Desktop, and other tools
This article explains an overview of Git, GitHub repository, how content is organized, and naming conventions used for Adobe documentation.
Quick start guides and videos for recording, editing, and uploading videos.
How Adobe lead writers should work in GitHub, Visual Studio Code, and Jenkins.
Learn different methods for logging issues and editing content.
How to resolve validation errors in the Jenkins pipeline, including validation summaries in pull requests and Slack. Validation errors include Git conflicts, illegal characters, BOM characters, package and structure, link check.
Push or activate content to go live. Set up auto-activate.
What Adobe lead writers should know about user guide setup in Git.
- Adobe Docs repo structure
- Required repo files
- User guide files (TOC.md file) and home page
- Naming files and folders
- How URLs are generated
- Landing pages and breadcrumbs
How to work with Table of Contents files to determine what appears in left nav of user guide.
Best practices for designing the home page of the user guide. Use a template for the home page.
Create a repository, add required files, and configure new Jenkins jobs for pushing content live
Guidance and best practices for creating a new repo in AdobeDocs
How to remove repositories
A basic introduction to Markdown styling. Page elements: Block quotes, Escape characters, Code Blocks, Code Blocks with line numbering, Definition Lists, Download Files, Headings, Images, icons and inline images, special characters, Links and Cross-References, Metadata, Image Links, Numbered Lists, Bullet Lists, Comments, Tables, Notes, Tips, Important, Video and video transcripts, More Like This/Related articles, CONTEXTUALHELP, Tabs, Shade Boxes
Quick overview of supported Markdown syntax for Adobe documentation.
Working with markdown tables and HTML tables.
Linking tips
Guidance and best practices for writing in Visual Studio Code.
- Prevent common errors
- Visual Studio Code tips
- Adobe Markdown Authoring extension for VSC
- Creating keyboard shortcuts
- Global Find/Replace and wildcard expression searches
- Visual Studio Code add-ons
- Install the AdobeDocs Chrome extension
Learn how to author a page in Experience league, add metadata, headings, paragraphs, and more.
How to write landing page descriptions.
A quick reference for creating and uploading video tutorials to Experience League. AdobeTV and MPC.
Learn about guide definitions and content types in technical writing.
Learn editorial guidance on steps and sub-steps technical writing.
Guidance and best practices for writing headings for concepts, tasks, and page titles
Learn how to improve your content’s SEO with both basic and advanced strategies including tools. Use AI to create prompts for title and description metadata and general authoring.
How to write titles and descriptions to optimize search.
How to use Acrolinx to check spelling, usage, and terminology.
Learn how to improve search results both internally and externally (that is, Google) in Adobe documentation.
Guidance and best practices for creating a TOC
Learn best practices and consequences of moving and renaming files and folders in Git, and of restructuring content in the TOC.
How to create a review branch for previewing content and staging a review
Learn to manage public github.com pull requests (PRs) and logged issues. Information about public github.com mirrors and user feedback.
Hide files, sections, or entire guides from search engines or in the TOC or both.
Clean-up tasks for writers to perform
How to use metadata and tags for AdobeDocs. Information about where to add metadata and metadata hierarchy. Common tags: solution, product, role, level, feature, feature-set, topic, title, description, exl-id, git-repo, mini-toc-levels, hide, hidefromtoc, index, recommendations (“More help on this feature”), internal.
Adding redirects for previous domains or for different locations within experienceleague.adobe.com
Creating and editing playlists using VSC extension
Creating and editing slides using VSC extension
A microsite is an HTML website that is uploaded to Experience League directly instead of through the standard authoring pipeline. Microsites are useful for displaying HTML sample files or providing tools or services not available through markdown authoring.
Learn how to set up content for contextual help popovers that can appear in the Experience Cloud product UI.
Understand how landing pages are generated. Understand the different syntax and validation rules.
Localization Overview
Applying DNL and UICONTROL to interface strings
Learning resources for Git and GitHub, GoURLs or go urls, upload videos to AdobeTV/MPC, Slack channels, list of writers, design resources, use Spectrum icons, logging jira tickets.
list of repos and writers and teams
Learn how to add metadata to ensure optimal Analytics data. Get tips for viewing reports.
You can create a collapsible section (sometimes called an accordion) that is hidden by default. The user can click the title to expand or collapse the section.
Use snippets or includes to share text among articles in a repo.
Featured Articles
More Resources
recommendation-more-help
92f1a422-8a81-400b-85d3-388f0c36dfda