Requirements for image files
Ensure that you name and save your image files correctly to avoid any processing errors.
Choose a meaningful file name that complies with the following requirements:
Use lowercase letters only.
Use hyphens instead of underscores or spaces.
Do not use single quotes or smart quotes.
Do not use special characters, such as (&, !, @,), and so on.
Do not include the folder structure in the name.
Do not start the file name with numbers. Instead, start with descriptive information.
Store images in the Git repository, in the
Resources\Imagesfolder specific to your project.
For example: For Pega Platform content, store the files in the
- Using callouts
Use callouts to draw the user's attention to a particular part of a graphic or to provide additional information. Each callout is composed of three parts: the rectangle that you use to select a part of the screenshot, the connecting line, and the callout text with an explanation.
- Selection and line settings
The use of common selection and line settings ensures consistency throughout documentation.
- Blur settings
The use of common blur settings ensures consistency throughout documentation.
- Magnification settings
The use of common magnification settings ensures consistency throughout documentation.
- Spotlight settings
The use of common spotlight settings ensures consistency throughout documentation.
Previous topic Media Next topic Using callouts