lib/doc/README.Documentation

   1 README.Documentation
   2
   3 by John Weiss [3/2000] jpweiss@idsi.net
   4
   5
   6 ================
   7 Introduction
   8
   9     The purpose of this file is *used* *to* *be* to provide a style
  10     sheet and helpful hints to those wishing to help with the
  11     LyX Documentation Project.  There's now a separate style-sheet for
  12     that.
  13
  14     If you're actually looking for documentation, check out the "Help"
  15     menu.  Start by reading the Introduction.
  16
  17 ================
  18 Why a separate documentation project?  Can't the developers do it?
  19
  20     In a word, no.  They're too busy adding features and squishing
  21     bugs.
  22
  23     Also, g++ is far more forgiving of style changes than a human
  24     brain.  As long as the code is correct, g++ will happilly compile
  25     it, and compile it the same way from machine to machine.  Human
  26     brains are far less forgiving and far more individualized.  So,
  27     the documentation needs to all be in a uniform style, in addition
  28     to being grammatically correct and easily readable.  That's a
  29     pretty big undertaking - which is why I volunteered to
  30     administrate the docs back in 1997.  Since then, I've passed the
  31     duty of maintaining the docs on to others.
  32
  33 ================
  34 Helping Out
  35
  36     If you'd like to contribute to the LyX Documentation Project,
  37     start by reading the file Intro.lyx.  It contains a description of
  38     the style of the documentation from a reader's perspective.  After
  39     that, read the LyX Documentation Style Sheet (DocStyle.lyx) and
  40     commit it to memory!
  41
  42
  43 John Weiss
  44 March, 2000