Re: Help Documentation

From: Derek Simkowiak <dereks kd-dev com>
To: Laurent Gauthier <lolo gothic remcomp fr>
cc: u07ih abdn ac uk, gnome-devel-list gnome org, recipient list not shown: ;
Subject: Re: Help Documentation
Date: Fri, 10 Dec 1999 11:02:42 -0800 (PST)

> Just use DocBook syntax (this is SGML/XML).  You don't have to care about
> the appearance when writing the documentation, but just the structure.

	Okay, so then is there a standard "structure" for documentation?
I.e., is the help a "Book" entity?  A "Chapter" entity?

	What about hotlinks in the documentation?  How do those work in
SGML?

	How many screenshots should I have?  Should I model my
documentation after a Microsoft Windows Help file?

	"man" pages have a very well-defined structure.  Shouldn't Gnome
have a help structure standard?  (BTW, I think the man page format would
seriously stink for a GUI application...)


--Derek

References:
- Re: Help Documentation
  - From: Laurent Gauthier

[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]