Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Should we include images in our templates? If so, should we also establish a standardized size? #253

Open
heykayla opened this issue Jul 11, 2022 · 1 comment
Labels
style question Questions for the style guide

Comments

@heykayla
Copy link

This question came up in a Community Docs meeting. A templateer wanted to know if they were allowed to integrate images or graphics in their template and asked if there was a standardized size for images they needed to follow.

@heykayla heykayla self-assigned this Jul 11, 2022
@heykayla heykayla removed their assignment Jul 19, 2022
@camerons
Copy link
Member

Good question, with a few interpretations:

Q1: Should documentation include images?
A1: There is some sound advice at: https://developers.google.com/style/images

Q2: Should images be used in the template.md.
A2: I can't think of a reason to use them, unless they are being used as an example of how to use an image.

Q3: Should images e used in the guide.md.
A3: Possibly, if the explanation is better done with an image, but probably not.

Note, images have a much higher cost of maintenance and translation than text. Consequently images have a high risk of becoming out of date. So we should try to avoid them.

@barbaricyawps barbaricyawps added the style question Questions for the style guide label Jul 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
style question Questions for the style guide
Projects
None yet
Development

No branches or pull requests

3 participants