• Documentation Section Structure

last modified February 4, 2007 by jluvsu2


How To- lowest common denominator- a how to is performing a series of steps (smaller tasks) to get to one goal
All other docs are built on how tos.



Tutorial- a tutorial because it's performing a series of tasks that lead to one outcome








Concern: what happens when people contribute new docs but don't know where to put it or don't put it in the right place?
have a new folder and everyone who writes new stuff dumped it in there and then the doc team moves it to the right place




Requirements- what we want our doc area to do:

  • a repository for new docs that have not yet been categorized/approved/edited
  • ability for doc team to screen new submissions- autonotify? editor access for doc team?
  • ability to move these new docs to an pre-defined appropriate landing space
  • landing space = outline= new organizational structure for where our docs are located- a map
  • tagging
  • versioning
  • automated review cycle once published.- when does it go up for review? staggered? based on release cycle? every few months?
  • content types- have fields that are required like title, purpose, pre-reqs, links,
  • ability to annotate specific parts of the doc in order to provide feedback- ability to turn them on or off (see djangobook.com)