Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Attribute

Audience

Definition

Metrics

Accessibility (a11y)

learners

See the project’s accessibility guidelines.

Internationalization (i18n)

translators

All learner-facing features have strings that have been properly internationalized, enabling translators to provide a localized experience

  • QA/user testing with 100% of scraped strings translated (or using dummy translations)

Internationalization (i18n)

translators

All author-facing features have strings that have been properly internationalized, enabling translators to provide a localized experience

  • QA/user testing with 100% of scraped strings translated (or using dummy translations)

Localization (l10n)

learners

The learner-facing parts of the feature has been adapted to any of the 12 (fact check) formally supported Open edX languages.

Localization (l10n)

authors

The author-facing parts of the feature has been adapted to any of the 12 (fact check) formally supported Open edX languages.

Localization (l10n)

operators

Ease by which a site operator can localize their instance to a language that’s not one of the formally supported Open edX languages.

Performance

learners

Learner-facing features operate smoothly: the site does not hang when loading the feature; clicking buttons and other interactive elements react quickly.

Performance

authors

Author-facing features operate smoothly: the site does not hang when loading the feature; clicking buttons and other interactive elements react quickly. Publishing units and courses is fast, regardless of course size.

Performance

operators

The project provides efficient, cost-saving backends and the ability to scale (to some degree as yet undefined)

Performance

software developers

The Open edX development environment is fast and enables quick iterative development

Usability

learners

The feature and its associated workflows are intuitively designed. Learners can quickly ascertain what the feature does, when and why they would use it, and how to use it.

  • wireframe and/or beta tests

Usability

authors

The feature and its associated workflows are intuitively designed. Authors can quickly ascertain what the feature does, when and why they would use it, and how to use it.

The process to configure a new feature in Studio Advanced Settings is easy, seamless and clearly documented.

  • wireframe and/or beta tests

  • Few to no questions in forums

  • Documentation exists for new feature addition

  • User tests/interviews prove ease of use

Usability

software developers

Developing on the Open edX platform is done via a stable interface that does not require huge amounts of head-bashing maintenance, esoteric knowledge, or vast amounts of 1-1 assistance.

  • Usages are well documented

  • Few to no questions in forums

Usability

operators

The process to install and configure a new feature is easy, seamless and clearly documented.

  • Few to no questions in forums

Scalability

learners

Interacting with learner features, other learners, and course team members works the same whether the course has a large or small number of units, enrollees, and/or concurrent number of learners.

  • Baseline metrics stay in place (such as performance metrics, usability metrics) at scale

Scalability

authors

Interacting with author features, other authors, learners, and course team members works the same whether the course has a large or small number of units, enrollees, and/or concurrent number of learners.

  • Baseline metrics stay in place (such as performance metrics, usability metrics) at scale

Scalability

operators

The feature can be scaled up or down to support the requisite number of concurrent users as required by the Instance’s use case.

  • Baseline metrics stay in place (such as performance metrics, usability metrics) at scale

Scalability

¿software devs?

¿does dave have an opinion? (like, could this be related to having a way of testing the feature’s scalability? but would that be on a product quality scorecard, versus a bigger piece of infrastructure for the overall project?)

Content Modularity

authors

If applicable, the new feature supports the ability to easily move content around a course outline, to reuse content, share, export.

  • beta tests

  • user tests

  • documentation exists for the feature’s use in both environments

Site Modularity

operators

Replacing or altering site components, such as a page’s header, an MFE, an object storage provider, or new XBlocks, is easy, seamless and well-documented.

  • If applicable, is themeable

  • Quality, comprehensive documentation exists around installing, enabling/disabling, and modifying the feature

Maintainability

Open edX product team

This feature is easy to maintain due to many qualities, such as quality documentation and low feature complexity. This encourages feature longevity and addition of future developers working on the feature as it will be easy to onboard them. Addition of the feature does not negatively impact performance or velocity of Named Releases.

  • quality of documentation

  • codebase POLA (needs further definition)

  • feature complexity

  • amount of tech debt

Maintained

Open edX product team

Does this feature have a community of developers surrounding it? If not, it runs the risk of becoming out of date, broken, or with major security holes.

  • Does this feature have one or more “maintainers” in the Open edX maintainer program?

  • Is there more than one contributor/maintainer?

  • Are PRs reviewed and merged in a reasonable timeframe?

  • What is the likelihood that this feature/project will be around in 5 years?

...