Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation image annotations lack consistency #4

Open
3 tasks
WalterMoar opened this issue Dec 8, 2023 · 1 comment
Open
3 tasks

Documentation image annotations lack consistency #4

WalterMoar opened this issue Dec 8, 2023 · 1 comment

Comments

@WalterMoar
Copy link
Collaborator

WalterMoar commented Dec 8, 2023

The screenshot images in the documentation should all use the same tools for annotations (arrows, circles, etc). This is tricky because we don't want something that will change and we're again in the position where things are inconsistent. Some images were done using pixelied but as a free website it's unknown how long it will be around.

Definition of Done

  • Update the Style Guide with a description of how / when to use images in documentation
  • Update the Style Guide with a description of how to annotate images (green for good/attention, red for errors)
  • Ensure all images follow the above
@WalterMoar
Copy link
Collaborator Author

Something to think about: https://thisisimportant.net/posts/screenshots-in-documentation

For accessibility, the text of the documentation must contain all the necessary information. The screenshots should enhance that information - not replace it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant