Securedrop: Rename `Terminology` to `Glossary` in the docs

Created on 29 Jan 2019  路  6Comments  路  Source: freedomofpress/securedrop

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.

UX docs help wanted

All 6 comments

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 馃檪

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

^ 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!鈥攔enaming "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

@ninavizz I'm down for a doc sprint!

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

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

Was this page helpful?
0 / 5 - 0 ratings