#1879 assigned enhancement

Glossary document

Reported by: marlowe Owned by: marlowe
Priority: normal Milestone: undecided
Component: documentation Version: n/a
Keywords: glossary docs usability terminology Cc:
Launchpad Bug:

Description

It has been stated that the documentation is very difficult for a new user. As discussed in IRC, the introduction of glossary document defining new or Tahoe specific terms may provide some clarity to the user. For example, terms a new user may be unfamiliar with include capability, furl and introducer.

Change History (8)

comment:1 Changed at 2012-12-11T22:17:31Z by davidsarah

  • Keywords glossary docs usability added

comment:2 Changed at 2012-12-11T22:17:46Z by davidsarah

  • Keywords terminology added

comment:3 Changed at 2012-12-13T17:03:02Z by marlowe

Terms to include:

nodes WUI WAPI erasure-code gateway capability shares mutable/immutable

comment:4 Changed at 2012-12-14T00:00:12Z by davidsarah

  • read-only
  • storage {client,server,protocol}
  • foolscap
  • furl
  • introducer
  • key generator
  • stats gatherer
  • log gatherer
  • object (= Tahoe file or directory)
  • share
  • dircap, filecap, write cap, read cap, verify cap
  • Tahoe URI

I think "web-API" is preferred over WAPI.

comment:5 follow-up: Changed at 2012-12-14T00:01:13Z by davidsarah

It also occurred to me that translating the glossary first, might be helpful to the translation effort for each language, to ensure consistency.

comment:6 in reply to: ↑ 5 Changed at 2012-12-14T00:03:15Z by davidsarah

Replying to davidsarah:

It also occurred to me that translating the glossary first, might be helpful to the translation effort for each language, to ensure consistency.

and to double as a technical dictionary of English <-> target language for end-users.

comment:7 Changed at 2013-12-03T17:39:55Z by amontero

Be aware that the term "client" is ambiguously used as a "client (to gateway) program" and as a gateway node.

This has been filed as #2127, and it could benefit of an appropiate glossary.

comment:8 Changed at 2016-05-06T16:31:47Z by marlowe

  • Status changed from new to assigned
  • Version changed from 1.9.2 to n/a
Note: See TracTickets for help on using tickets.