VbzCart/docs/meta

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:

• help: root index for help area
  • help/terms: terminology
  • help/ui: help for specific software pages/areas

Tools

Templates for linking to documentation pages:

• Template:l/vc/help: links to help pages, wherever they are or will be
• Template:l/vc/term: links to a terminology help page
• Template:l/vc/piece: links to concepts/how-to pages
• Template:l/vc/code: links to the source code repository for a specific file
• Template:l/vc/table: links to a table definition
• Template:l/vc/query: links to a query (view) definition
• Template:l/vc: links to anything under VbzCart
  • Currently used for the Template:L/vcs; if that's the only place without its own template, then maybe it should have one.