Jedi Documentation Charter

"Clear, your content must be. Confused, it will not be." – Yoda, master of style

Objective

Ensure documentation quality worthy of the Jedi Temple (and prevent readers from going crazy reading your notes).

Fundamental Principles:

  • A clear title: no “Misc_v3_notes”, thank you.

  • Intro with context: the why before the how.

  • Well-structured lists: like this one.

  • Screenshots if needed: no excuse, even Chewbacca knows how to take a screenshot.

  • No obscure inside jokes: if only 2 padawans understand, it goes straight to the Forbidden Databloc.

Language Style

  • You address another Jedi → "you", simple, direct.

  • No unnecessary jargon. If you write "holistic implementation of a strategy for intergalactic information dissemination," you're a Sith.

Did this article help you?