Adding images and screenshots
Revision Information
- Revision id: 228169
- Created:
- Creator: Kiki
- Comment: Adding complete KB guidelines
- Reviewed: No
- Ready for localization: No
Revision Source
Revision Content
Screenshots improve articles by illustrating important concepts. Sometimes a user needs to see a logo or a button, not just read about it. Take a screenshot of the image and add it to the article you're writing.
This is confusing for readers: "To start a Firefox Hello conversation, click the Hello Button."
Readers don't know what the Hello button looks like.
Try this: "To start a Firefox Hello conversation, click ."
Now readers can visualize what the article is talking about.
Table of Contents
Create screenshots on a computer or mobile device
To learn how to create screenshots for the Knowledge Base and what editing tools you can use, see How to make screenshots.
Add new screenshots to Knowledge Base articles
You can visit the Media Gallery and use the button to upload your screenshot image file. To insert an image from the Media Gallery into an article you're editing, type in [[Image:title]] (substitute the actual title of the image, instead of title) at the point where you want the image to appear. For details, see Add images and screenshots to Knowledge Base articles.
You can also upload an image and insert it into an article while editing an article.
To upload the image:
- Begin writing or editing an article.
- Click
- The insert media dialog opens. Click
- A new tab opens with an Upload New Media File dialog box. Click
- A new dialog box opens. Give your Screenshot a title and a description. Click
To add the image to an article:
- Begin writing or editing an article.
- Click
- Select an image from the gallery. Click
Tips for adding screenshots
- Don’t add screenshots to every concept. Just use them for concepts that need illustrations.
- Screenshots should match what the user sees on the screen, which is sometimes different, depending on your operating system. See How to use "For" tags to show different screenshots for Windows, Mac and Linux users.
Complete Knowledge Base Guidelines
If you're interested in editing and writing documentation, here are a few resources that should help explain how we do things:
Create new support articles
- Writing guide for Knowledge Base articles — Guide to writing techniques and styles that we use to make articles more engaging and effective. For the mechanics of actually creating or editing articles, see:
- Create a new Knowledge Base article – Steps for creating a new article along with some sample wiki markup to get you started
- Anatomy of a Knowledge Base article – Explains the basics of how articles are built
- Article Description - Explains how to write description for a support article
Improve existing support articles
- Improve the Knowledge Base - Learn how to improve SUMO Knowledge Base
- Edit a Knowledge Base article - Steps for editing an existing article
Other guidelines
- About the Knowledge Base — An overview of the mechanics of our Knowledge Base
- Article review and approval guidelines - Reviewer guidelines for Knowledge Base
- How to make screenshots — A step-by-step guide to creating screenshots to use in articles
- Add images and screenshots to Knowledge Base articles — Explains how to add screenshots to articles (You're here!)
- Add images and screenshots to Knowledge Base articles — Explains how to get screenshots and other images to display correctly in articles
- Markup cheat sheet – The most commonly used wiki markup in our articles
- Markup chart — Wiki markup reference. It gives examples and shows the markup that produces them
- How to use {for} — Special wiki markup that lets us show instructions for different application versions (for example, Firefox 40) and operating systems such as Windows and Mac OS
- Using Templates — Templates are reusable pieces of content. You can include a complicated set of step-by-step instructions in multiple articles by using a template.
- When and how to use keywords to improve an article's search ranking — Explains when adding keywords to an article is appropriate
- To see more guidelines on Knowledge Base contribution, click here