northumbrian-data / support Goto Github PK

Problem

Across the gliff.ai platform and customer experience we use a variety of custom terms to describe features, actions etc. The user is likely to feel confused by this when they are new - this will cause an influx of help requests or a poor user experience.

Solution

Create a gliff.ai Term Glossary section within the user documentation.
Take inspiration from Slack's Term Glossary.

Considered Alternatives

Potential terms could originate from:

• Platform Names
• User Roles
• Features
• Technical Jargon

Additional Context

Look for a DOCUSAURUS plugin to assist the process and future updates?

We should document the keyboard shortcuts for each app as a table somewhere on each apps page?

See https://github.com/gliff-ai/annotate/pull/318

Is your feature request related to a problem? Please describe.

gliff-ai/annotate#269 introduces a new Spline Submenu and a new lasso spline.

Describe the solution you'd like

We need to document this for users.

Describe alternatives you've considered

None

Additional context

None

Problem

Relates to northumbrian-data/roadmap#79.

Users should have a comprehensive guide to keyboard shortcuts across the platform and all 4 interfaces [including both visual tooltip presentation and plain text for helping user understanding].

Solution

Relates to https://github.com/gliff-ai/dominate/issues/553.

• Create keyboard shortcuts' assignments Documentation Article

ANNOTATE

CURATE

AUDIT

MANAGE

Considered Alternatives

N/A

See https://github.com/gliff-ai/annotate/pull/329

Problem

The common industry practice is to name user documentation something along the lines of support or help centre. The current name of document does not communicate the user documentation in a manner all users would easily understand and then navigate to to help their own platform use.

Solution

Change the user documentation from DOCUMENT to SUPPORT. This needs to be applied within the user documentation code itself as well as the url links, i.e. support.gliff.app to CNAME etc.

The updated links will then need to be applied within the platform itself.

Considered Alternatives

N/A

The repo's README.md Contribution section needs updated to reflect contributions. Complete via All Contribution Bot.

Is your feature request related to a problem? Please describe.

gliff-ai/annotate#271 introduces a new Bounding Box tool.

Describe the solution you'd like

We need to document this for users.

Describe alternatives you've considered

None

Additional context

None

Our default light green looks good on a dark background, but when used for text on a light background, it doesn't have enough contrast and is hard to read/not great for accessibility

So I think with screenshots we want consistency in treatment.

The size of the screenshots should be limited with: width: 100%/960px always + height: 480px or less.

I think the browser wrap is a visual distraction(?) for the purpose of the user documentation but the screenshots do need separated from the background. Edit each screenshot via Screely with: window: no window + background: #DADADA + padding: 10px 10px.

Quality of the screenshots are also important. For areas where it is cropped in try zooming in via your browser so the screenshot has a larger size and therefore quality.
With the above size limits, annotating screenshots could be very valuable. I would use preview: markup via Mac with: shape: rounded square + fill: none + outline: #02FFAD + outline width: 2nd largest.

Happy to alter anything above if in practice it isn’t working! Possibly worth trialing with one and then grab another review before committing to changing all screenshots.

I've also just become aware of Scribe which may be a useful to to help build the documentation content?

Examples:

Originally posted by @joshuajames-smith in #38 (review)