Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename Terminology to Glossary in the docs #4083

Closed
heartsucker opened this issue Jan 29, 2019 · 6 comments · Fixed by #4405
Closed

Rename Terminology to Glossary in the docs #4083

heartsucker opened this issue Jan 29, 2019 · 6 comments · Fixed by #4405
Labels
docs help wanted Issues we would definitely appreciate volunteer help with UX

Comments

@heartsucker
Copy link
Contributor

Description

This is the expected term, and we should make a reference to the glossary early in each of the respective sections like

  • Source Guide
  • Journalist Guide
  • Admin Guide
  • Install SecureDrop

User Research Evidence

While a UX team was looking at the docs, they asked "why isn't there a glossary" since they couldn't find it.

@bumbleblue
Copy link

I would want to add that a glossary/terminology section would also make terminology across website and documentation more consistent. Once you decide on the words to use, there can be a sprint to find&replace some of the confusing terms 🙂

@bumbleblue
Copy link

Example: What's a SD workstation? vs. a journalist interface? what constitutes secure viewing?

@ninavizz
Copy link
Member

ninavizz commented Feb 25, 2019

^ I love the idea of a documentation sprint; we're currently doing lots of mini/adhoc efforts, and currently @zenmonkeykstop and (I think?) @huertanix are co-leading the first major overhaul of the Source guide. This is a great bit for them to consider (poke, poke!—renaming "terminology" to "glossary;" goal being prioritizing clarity and resonance among a wider swath of users, versus the linguistic precision that creates cognitive dissonance... cuz humans gonna be humans, and not perfect).

There is an open issue in the sd-ux repo to unite nomenclature across the entire product, as informed by findings from the Workstation project. That said: it's critically important this does NOT fall off the priorities radar... and I appreciate this issue, so much, for reinforcing that urgency. Thank you, Eileen!!

P.S.: @bumbleblue if you ever feel inspired to attend a crit at 17:00UTC we'd love to have your voice and thoughts! https://github.com/freedomofpress/securedrop-ux/wiki/Meetings

@huertanix
Copy link
Member

@ninavizz I'm down for a doc sprint!

@ninavizz
Copy link
Member

Pokey pokey @eloquence you mentioned in standup today you'd be doing some work in RTD? 😸

@redshiftzero redshiftzero added the help wanted Issues we would definitely appreciate volunteer help with label May 1, 2019
@lbeaufort
Copy link
Contributor

Hi there! I'd like to work on this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs help wanted Issues we would definitely appreciate volunteer help with UX
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants