openlibhums / openlibhums/memory-alpha

Documentation Images Alt-Text

Open
#40 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

a11y documentation Priority medium
Dominant language
Markdown
Stars
0
Forks
0
Avg merge
4d 14h
Merged PRs (30d)
2

Description

Rationale

  • The documentation includes images, primarily screenshots.
  • These should have alt-text.
  • As the documentation is being revised, it is a work in progress, and we do not know which images will remain at in the final version.
  • The purpose of the documentation is to assist users with Janeway, descriptions of screenshots may not be helpful in that as they are designed to assist with visual use. Assistance with non-visual use is required..
  • The Accessibility project is driving changes, particularly to navigating Janeway non-visually, and so this cannot yet be documented.

Approach

  • while drafting documentation images will be given brief alt-text, so that there is something there as a 'fall back'
  • a spreadsheet will be kept of images and their location and existing alt-text
  • once drafting is completed, then this spreedsheet will be reviewed, and each image considered within its context for the appropriate alt-text.
  • As part of this review, we will consider description versus purpose of these images, and the role they play - to ensure that the documentation assists with non-visual use.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the documentation images and their locations, recording existing alt-text in the proposed spreadsheet. After drafting is complete, assess each image in context for description versus purpose and review the result alongside the evolving work on non-visual Janeway navigation.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
accessibility, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.