Keep your sentences short and get to the point fast. If your sentence is over 20 words long or uses multiple commas, consider breaking it up into separate sentences. Sentences over 20 words in length can be especially challenging for readers.
Don’t be excessively polite. Avoid using “please” or “kindly do …” in technical documentation.
Follow the provided documentation template and don’t edit the existing links in the template. When including new links, read using links in documentation in the contributor guide.
AEP is not an approved public-facing term. Please use Adobe Experience Platform on first use, then Experience Platform, then Platform.
Don’t use: Before you can export data from AEP to YourDestination, make sure you read and complete these prerequisites.
Use: Before you can export data from Adobe Experience Platform to YourDestination, make sure you read and complete these prerequisites.
When using screenshots, please ensure that your screenshot captures the entire Platform UI screen.
When marking up images to highlight a certain control or label on the page, try to follow the markup style used by the Experience Platform documentation team. Notice how Profile-based is highlighted in this screenshot.
Please use png format images.
Please don’t use numbered screenshots as filenames. Image filenames should be descriptive.
Author the documentation and create the documentation pull request (PR) from a branch in your fork other than the main branch. Refer to the submit destination for review section when authoring in the GitHub interface or in your local environment.