/
OpenLMIS Styleguide

OpenLMIS Styleguide

Owned by Nick Reid (Deactivated)
Last updated: Nov 03, 2017

In Progress

This document is in progress

This style guide aims to be concise, and not specific to a single form of media - each form of media should have their own style guides that further describe our concepts.

Roadmap

This is in progress, the following table concept subjects that need definition, and the priority of those subjects.

ConceptShort TermMedium TermLong TermParking Lot

Domain concepts
- What's an "orderable"?


  • Menu heirchy and "depth"
  • How does facility/program selection work
  • How to talk about orderable and commodity types


System behavior
- What causes an error?
- How are conflicts resolved?

  • List of technologies underneath UI
  • Move list of technologies into RTD (in architecture)
  • Transifex & i18n
  • DTO object type formatting guidlines
    • ISO data strings
    • Currency stings
    • Languange strings
    • ect...
  • Explain perferred patterns behind architecture, and document WHY decision
    • Keep explanations brief
    • Examples
      • URL Driven
      • Caching behavior
      • Offline stuff
      • Accessiblity and forms/tables/ect
      • CSS & SMACSS & Semantic HTML


Visual style
- Branding
- Error message location



Language style
- How are messages written?
- How do we address an end user?
  • Run short meeting
    • acknowledge limits of language - dates, currency, ect
    • Focus on purpose of style
    • Make plan to re-socialize language style



Related content

OpenLMIS: the global initiative for powerful LMIS software