All writing should abide by the values

Originally drafted August 18, 2022 and last tended May 16, 2023 by Matt McElwee.
(See Revision History).

  1. Accessible: documentation should be readable by everyone within the intended scope and audience.1 When the documentation is more technically oriented or requires some pre-requisite knowledge, notes and essays should clearly list pre-requisite knowledge. This allows every role, regardless of level, to feel included.
  2. Empathetic
  3. Well-Tended
  4. Iterative
  5. Collaborative
  6. Honest: notes and essays should demonstrate both academic and epistemic honesty. The best possible chance must be made to avoid the Dunning-Krueger effect.

Footnotes

  1. Audience is ill-defined at this time. ↩

Pages Linking to this Page