VbzCart/meta

from HTYP, the free directory anyone can edit if they can prove to me that they're not a spambot
Jump to: navigation, search

Organization

There are two main types of documentation: technical and user. They can cross-link to each other where appropriate.

  • Technical documentation consists of:
    • pieces: concepts and how-to
    • coding: actual code (data structures and source code repos)
  • User documentation is designed to be invoked from within the software's web interface, and hence is rooted at ui:
  • ui: root page
    • ui/terms: terminology
    • ui/pages: help for specific pages/areas within the software

I'm considering renaming "ui" to "help" and "pages" to "ui". We would then have:

Tools

Templates for linking to documentation pages: