Re: documentation

["Greg Ferguson" <gferg@hoop.timonium.sgi.com>]

On Dec 3,  2:41pm, Brian Stephenson wrote:
> Subject: documentation
> Hi
>     I am thinking of writing a howto for the LinuxBIOS project,
> I am currently obtaining and organising information for this,
> but I am completely new when it comes to documentation,
> I just started looking at the requirements on the web site and
> hopefully should get started soon.
> I envisage the first document to be a mini howto as it only
> involves one type of hardware, with many more to come
> later.
>
> any tips would be most welcome.

Start with the LDP Author Guide:

    http://www.linuxdoc.org/LDP/LDP-Author-Guide/

In our "author's resources" area

   http://www.linuxdoc.org/authors/index.html#resources

there are pointers to various helpful documents/books
including:

   DocBook: The Definitive Guide, by Norman Walsh and Leonard Muellner
   http://docbook.org/tdg/html/docbook.html

   Using DocBook HOWTO, by Jorge Godoy
   http://www.ibiblio.org/godoy/using-docbook/using-docbook.html

and there also pointers to downloadable template files for
HOWTOs (in DocBook and Linuxdoc SGML).

(I'll add your info to the "docs in progress" page).

Let me know if you have any questions.

r,

-- 
Greg Ferguson     - s/w engr / mtlhd         | gferg at sgi.com
SGI Tech Pubs     - http://techpubs.sgi.com/ |
Linux Doc Project - http://www.linuxdoc.org/ | gferg at metalab.unc.edu


--  
To UNSUBSCRIBE, email to ldp-discuss-request@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org