bcgov / bcgov/common-hosted-form-service-techdocs

Documentation image annotations lack consistency

Open
#4 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
1
Forks
9
Avg merge
19m
Merged PRs (30d)
4

Description

The screenshot images in the documentation should all use the same tools for annotations (arrows, circles, etc). This is tricky because we don't want something that will change and we're again in the position where things are inconsistent. Some images were done using pixelied but as a free website it's unknown how long it will be around.

## Definition of Done
- [ ] Update the Style Guide with a description of how / when to use images in documentation
- [ ] Update the Style Guide with a description of how to annotate images (green for good/attention, red for errors)
- [ ] Ensure all images follow the above

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the documentation Style Guide and the existing screenshot images referenced by the issue. Identify the current annotation approaches and define a consistent, durable approach for documentation images. Done means the Style Guide describes image use and annotation colors, and the documentation images follow those guidelines.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.