Skip to content

Commit 1f31b51

Browse files
kimsaucejpipkin1
andauthored
Clarify screenshot image guidance in Style Guide (#5424)
* Clarify screenshot image guidance in Style Guide * Update docs/contributing/style-guide.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> --------- Co-authored-by: John Pipkin (Sumo Logic) <[email protected]>
1 parent 5a297a7 commit 1f31b51

File tree

1 file changed

+22
-17
lines changed

1 file changed

+22
-17
lines changed

docs/contributing/style-guide.md

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -735,30 +735,42 @@ You can use a link to a file embedding the entire file, or embed a range of code
735735
</TabItem>
736736
</Tabs>
737737
738-
### Image sizes
738+
### Logos
739739
740-
When sizing images, use your discretion.
741-
742-
#### Logos
743-
744-
For square logos, set the width to about 45-55px.
740+
When sizing images, use your discretion. For square logos, set the width to about 45-55px.
745741
746742
| &#9989; **Do** | &#10060; **Don't** |
747743
|:---------------|:-------------------|
748744
| <img src={useBaseUrl('img/contributing/logo-yes.png')} alt="Screenshot showing correctly sized logo" width="400"/> | <img src={useBaseUrl('img/contributing/logo-no.png')} alt="Screenshot showing oversized logo" width="440"/> |
749745
750746
For wide logos (like [in this doc](/docs/integrations/microsoft-azure/iis-7/)), set the width to about 90-120px.
751747
752-
#### Screenshots
748+
### Screenshots
749+
750+
Use screenshots only when they clarify complex instructions. Our UI changes often, so minimizing screenshots reduces maintenance overhead.
751+
752+
* Prefer clear, concise text instructions over images when possible.
753+
* Only include screenshots if they significantly aid user understanding.
754+
* Avoid screenshots for simple UI interactions.
755+
* When updating docs, evaluate whether screenshots are outdated or redundant.
756+
* If you come across unnecessary screenshots, use your judgment to delete or replace them.
753757
754-
Ensure that screenshots are large enough so that the content is legible, but not comically oversized. Use your discretion.
758+
Make sure screenshots are large enough to be legible, but never wider than 800px. Avoid oversized images.
759+
760+
By default, images that you insert into a page are set to be responsive-resized for the type of device the reader is using.
761+
762+
Use the following syntax to add screenshots:
763+
764+
```md
765+
<img src={useBaseUrl('img/<your-image-file>.png')} alt="Descriptive alt text" style={{border: '1px solid gray'}} width="500" />
766+
```
767+
768+
Add appropriate `alt` text for accessibility. See [Add an image](#add-an-image) for more.
755769
756770
| &#9989; **Do** | &#10060; **Don't** |
757771
|:---------------|:-------------------|
758772
| <img src={useBaseUrl('img/contributing/screenshot-yes.png')} alt="alt-text" width="400"/> | <img src={useBaseUrl('img/contributing/screenshot-no.png')} alt="alt-text" width="400"/> |
759773
760-
Screenshots should never be wider than 600px.
761-
762774
### Images in lists
763775
764776
When adding an image to a bulleted or sequential list, include the image snippet in-line with the list item, with a `<br/>` element in between, like this:
@@ -785,13 +797,6 @@ When adding an image to a bulleted or sequential list, include the image snippet
785797
</TabItem>
786798
</Tabs>
787799
788-
### Screenshots
789-
790-
Capture screenshots using SnagIt in .png format. Use SnagIt's border effect to apply a gray (RGB 212, 212, 212) four-point border.
791-
792-
By default, images that you insert into a page are set to be responsive - resized for the type of device the reader is using.
793-
794-
795800
### Masking sensitive information
796801
797802
We mask sensitive information like usernames, email addresses, and IP addresses. In Snagit or a similar program, use the shape tool to mask the text using solid gray, (RGB 212, 212, 212).

0 commit comments

Comments
 (0)