P:Documentation/Naming Conventions

From Open Source Ecology
Revision as of 16:01, 17 October 2018 by Alexau (talk | contribs) (Created page with "== Intro == Clarify how topics in the wiki relate to each other, especially for: * Newcomers - see how things relate to each other * Contributors - know how to add new topics...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Intro

Clarify how topics in the wiki relate to each other, especially for:

  • Newcomers - see how things relate to each other
  • Contributors - know how to add new topics to existing ones
  • Upkeep - manage complexity by prioritizing upkeep of some parts of the wiki over others and manage team energy

The idea is to use naming conventions based on BEMIT, a CSS naming convention. As applied to this wiki, I recommend these conventions:

  • Let there be 3 types of topics: process, object, and narrative
  • Let pages be named or tagged using the first letter of each type of topic, such as p- and o-
  • Let there be 3 types of narrative topics: .n-folk, .n-map, .n-view. There will never be an n- topic.
  • Let there be a parent and children topics


References

How To

Examples