docs icon indicating copy to clipboard operation
docs copied to clipboard

Help Wanted: Identify documentation content that would benefit from the addition of visual assets

Open cwarnermm opened this issue 3 years ago • 2 comments

Problem space In the Mattermost Product Documentation, there is content that is currently text-heavy. This text-heavy content is beneficial to visitors who learn well by reading, but is less beneficial to visual, audio, or kinaesthetic learners.

Target audience All users

Goal

  • Identify content across the product documentation site that would benefit from the addition of visual elements, such as animated GIFs, embedded videos, workflow diagrams, or static screenshots to supplement existing material.
  • Design, develop, record, or capture the visual asset and incorporate it on the documentation page.

Delivery expectations

  • 1 PR per documentation page that would benefit from visual elements
  • Visual elements introduce new maintenance effort going forward, so please ensure that visual elements add good value to the target audience
  • All visual elements featuring Mattermost product interfaces must use the default Denim theme. Please do not create visual assets featuring Mattermost clients using a custom theme or any other theme other than Denim. This is to ensure that all product imagery across the documentation site remains consistent.
  • Comment in the PR to request a generated preview of your work. The Docs team will add the appropriate labels to your PR.

Tech needed

  • Sphinx
  • RST format
  • Mattermost product functionality
  • screen capture or recording software

Affected repository mattermost/docs

Where to get help Join the Mattermost Docs team on the Mattermost Community Server in the ~Documentation Working Group channel to discuss this ticket, or feel free to comment in this docs ticket.

cwarnermm avatar Oct 07 '22 18:10 cwarnermm