Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
4b7b3c37
Commit
4b7b3c37
authored
Sep 14, 2021
by
Suzanne Selhorn
Committed by
Diana Logan
Sep 14, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Image guidance recommends real-world scenarios
parent
e1076b8f
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
8 additions
and
3 deletions
+8
-3
doc/development/documentation/styleguide/index.md
doc/development/documentation/styleguide/index.md
+8
-3
No files found.
doc/development/documentation/styleguide/index.md
View file @
4b7b3c37
...
...
@@ -1081,10 +1081,15 @@ To select your avatar:
## Images
Images, including screenshots, can help a reader better understand a concept.
However, they
can be hard to maintain, and should be used sparingly.
However, they
should be used sparingly because:
Before including an image in the documentation, ensure it provides value to the
reader.
-
They tend to become out-of-date.
-
They are difficult and expensive to localize.
-
They cannot be read by screen readers.
If you do include an image in the documentation, ensure it provides value.
Don't use
`lorem ipsum`
text. Try to replicate how the feature would be
used in a real-world scenario, and
[
use realistic text
](
#fake-user-information
)
.
### Capture the image
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment