doc/webserver/documentation-guidelines.html

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
   2 <!--
   3  File        :  $Source: /cvsroot/ijbswa/current/doc/webserver/documentation-guidelines.html,v $
   4
   5  Purpose     :  Gives direction on writing documentation.
   6                 This file belongs into
   7                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
   8
   9  $Id: documentation-guidelines.html,v 1.1 2001/06/13 14:20:37 swa Exp $
  10
  11  Written by and Copyright (C) 2001 the SourceForge
  12  IJBSWA team.  http://ijbswa.sourceforge.net
  13
  14  Based on the Internet Junkbuster originally written
  15  by and Copyright (C) 1997 Anonymous Coders and
  16  Junkbusters Corporation.  http://www.junkbusters.com
  17 -->
  18
  19 <head>
  20 <title>Junkbuster|Documentation Guidelines</title>
  21 <link rel=stylesheet type="text/css" href="swa.css">
  22
  23 </head>
  24
  25  <body bgcolor="#ffffff"
  26  topmargin="0" leftmargin="0" marginwidth = "0" marginheight = "0"
  27  text="#000000"
  28  link="#0000ff"
  29  vlink="#ff0000"
  30  alink="#ff0000"
  31  >
  32
  33 <body>
  34 <p>
  35 <br><br>
  36 <h1>Documentation guideline:</h1>
  37 <p>
  38 All docs should be ...
  39 <ul>
  40   <li>in a format that is widely used. I propose HTML.
  41   <li>we either
  42       <ul>
  43         <li>generate man pages from the documentation (let's _NOT_ write them manually), or
  44         <li>we have a man page that points to the documentation (I propose
  45             this option)
  46       </ul>
  47   <li>have a consistent layout
  48   <li>have a link to the latest version of the document (i.e. point to a URL at sf)
  49   <li>be consistent with the redirect script (i.e. the junkbuster program
  50       points via the redirect URL at sf to valid end-points in the document)
  51   <li>started from scratch but recycle parts from the original junkbuster documents
  52 </ul>
  53
  54 <br>
  55
  56 <hr>
  57 <p><address><a href=mailto:ijbswa-developers@lists.sourceforge.net>the developers</a></address><p>
  58 <!-- hhmts start -->
  59 Last modified: Wed Jun 13 16:26:48 CEST 2001
  60 <!-- hhmts end -->
  61 </body>
  62  <!--
  63  This program is free software; you can redistribute it
  64  and/or modify it under the terms of the GNU General
  65  Public License as published by the Free Software
  66  Foundation; either version 2 of the License, or (at
  67  your option) any later version.
  68
  69  This program is distributed in the hope that it will
  70  be useful, but WITHOUT ANY WARRANTY; without even the
  71  implied warranty of MERCHANTABILITY or FITNESS FOR A
  72  PARTICULAR PURPOSE.  See the GNU General Public
  73  License for more details.
  74
  75  The GNU General Public License should be included with
  76  this file.  If not, you can view it at
  77  http://www.gnu.org/copyleft/gpl.html
  78  or write to the Free Software Foundation, Inc., 59
  79  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  80
  81 $Log: documentation-guidelines.html,v $
  82 Revision 1.1  2001/06/13 14:20:37  swa
  83 first import of project's documentation for the webserver.
  84
  85 -->
  86 </html>