G2 Plain-language layer & in-product help
- Area
- G — Cross-cutting UX
- Audience
- both
- Kind
- feature
- Status
- accepted
- Maturity
- building
- Labels
- ux
The feature in the specification · Read at
Requirements
On an operator's surface, domain terms MUST carry an inline explanation wherever they appear. A member's surface shows none (G2-R16).
- locked by
- 0.9.0 met
- recorded done
- lemonfibercrates/lemonfiber-core/src/glossary.rscrates/lemonfiber/src/render/seed.rscrates/lemonfiber-core/src/glossary/tests.rscrates/lemonfiber/src/render/seed/tests.rs
- recorded partial
- lemonfiber-companionapp-modules/operator/src/Internal/ShowsWhatItsWordsMean.phptests/Feature/SeeingWhatTheWordsMeanTest.php
- cited by
- lemonfiber@062c9717e0lemonfiber@c03bcc19aelemonfiber@059a7a4a4elemonfiber@08f813149alemonfiber-web@0a0b9aecd7lemonfiber-web@d9a4cbb419lemonfiber-web@0abb2adea8
Explanations MUST state purpose and consequence, not formal definition.
- locked by
- 0.9.0 met
- recorded done
- lemonfibercrates/lemonfiber-core/src/glossary.rscrates/lemonfiber/src/render/glossary.rs
- cited by
- lemonfiber@3d135cdbfe
One concept MUST use one term consistently across all surfaces and messages for each audience: the operator's term on an operator's surface, and the household's on a member's surface (G2-R16).
- locked by
- 0.9.0 met
- recorded done
- lemonfibercrates/lemonfiber/src/render.rscrates/lemonfiber-core/src/app.rs
- recorded partial
- lemonfiber-companiontests/Arch/TheNamesThisProductGivesTest.php
- cited by
- lemonfiber@1b5791a8a8lemonfiber@3d135cdbfelemonfiber-web@151fdcfbddlemonfiber-web@4e26bf0684lemonfiber-web@557f814fa1
On an operator's surface, sizes, durations and rates MUST be contextualised where the consequence is knowable. A member's surface states the consequence in place of the figure (G2-R16).
- locked by
- 0.9.0 met
- recorded done
- lemonfibercrates/lemonfiber-core/src/doctor/headroom.rs
- cited by
- lemonfiber@4d46d2c8f9
On an operator's surface, plain language MUST accompany the domain term, not replace it. On a member's surface, household words replace it (G2-R16).
Extended explanation MUST be available on request and MUST NOT be mandatory.
Explanations MUST be dismissible and disableable.
An explanation MUST NOT explain by resemblance, and MUST NOT talk a cost away.
- locked by
- 0.9.0 met
- recorded done
- lemonfibercrates/lemonfiber-core/src/glossary.rs
- cited by
- lemonfiber@ec7c13a464lemonfiber@3d135cdbfe
Where services use different terms for one concept, the mapping MUST be stated.
Error messages MUST follow the same plain-language rules.
- locked by
- 0.9.0 met
- recorded done
- lemonfibercrates/lemonfiber/src/exit.rscrates/lemonfiber-core/src/endpoint.rs
- cited by
- lemonfiber@df63f8c6a7
Text MUST avoid idiom and cultural reference so it translates cleanly.
Explanations MUST be versioned alongside the behaviour they describe.
Every acronym in shipped text MUST resolve to a glossary entry, or to a word declared ordinary and carrying the reason it is.
- locked by
- 0.9.0 met
- recorded done
- lemonfibercrates/lemonfiber-core/src/glossary.rs
- recorded partial
- lemonfiber-companiontests/Arch/EveryAcronymAnOperatorReadsTest.php
- cited by
- lemonfiber@ec7c13a464lemonfiber@d79a56949alemonfiber-web@a6e7b51e10lemonfiber-web@9e2ee1bde9lemonfiber-web@292d91a269lemonfiber-web@79d5c19a7e
The names lemonfiber gives its own things — the words that also name a file, a command or an argument — MUST be declared, and every locale MUST render a declared name as declared and translate only the text around it.
- locked by
- 0.19.0 unmarked
- recorded partial
- lemonfiber-companiontests/Arch/TheNamesThisProductGivesTest.php
- cited by
- lemonfiber-companion@acac2246bc
On every surface, the label of a control, a tab, a menu item or a section heading MUST name what it opens or does in at most three words and MUST NOT be a sentence; a sentence MAY explain beside it, and a name declared under G2-R14 counts as one word.
A member's surface MUST NOT show a service's name, a domain term, a size, a rate, an address, a version, a stage of the pipeline, or how the stack stands, and MUST say what it says in household words, leading with what the member can do. Where it names the stack it MUST call it the house. A member's surface is any screen drawn for a household member's session on any surface, any notification sent to a member, and any text lemonfiber places where the household asks for things.
- locked by
- 0.18.0 unmarked
- recorded partial
- lemonfibercrates/lemonfiber-core/src/household/run/notices.rscrates/lemonfiber-core/src/household/run/handing_over.rscrates/lemonfiber-core/src/wishing/ask.rscrates/lemonfiber-core/src/household/run/notices/tests.rs::nothing_the_house_is_shown_is_in_anything_but_its_own_wordscrates/lemonfiber-core/src/household/run/handing_over/tests.rs::nothing_handed_over_is_in_anything_but_the_households_own_words
- cited by
- lemonfiber@2fdb17698flemonfiber-web@d9a4cbb419lemonfiber-companion@032c04f9f5