On Monday 07 May 2001 13:42, you wrote:
> I've forwarded your message to the lyx-docs mailing list. If you haven't
> subscribed to it yet, you should. It's very low volume - completely in
> the noise compared to lyx-devel :-)
:) Actually, I intended this message to be posted in here.
> Yes, this is wise. I'd like to keep the User Guide more or less as it is.
> Updates, or addressing the intro as you suggest below, are needed, but
> structurally, I think it's pretty good. Not to mention I don't want to
> obliterate the hard work John Weiss already put into this. But it is in
> danger of becoming dated if we aren't careful with it.
Yes, you're right about this. I the User Guide is pretty good, as is the
Introduction / Tutorial. My only suggestions for those two documents are
things that can wait until we get to the pre1.2 release update.
> > We could play with such an organization now, see if we can come up with
> > something clean (I would say no more than three levels deep), and
> > reasonably well balanced.
>
> Might work. I've often wondered if we could recombine Extended,
> Customization, and (the almost thoroughly useless) Reference Guide into
> two, more compelling, documents. Care to take a crack at an outline (using
> the existing Section/Subsection headings)?
Certainly. Sounds like a good idea to me, and would help to bring things into
a little more focus compared to the current structure. I'll look at it this
weekend, and post the results here.
> > I was also thinking we might want to review the other documents in a
> > similar manner. For example, the opening section of the User's Guide has
> > all the ear marks of being major propaganda, which I have nothing
>
> Yeah, most of the into in the UG could probably be moved to Intro.
Well, I don't know how much we need to move across documents, I think mostly
just streamline/re-organize what's in the current documentation (similar to
reorganizing the Exteneded/Customization/Reference Documentation). I think
most of JW's work stands very well (except for things like the tone and that
intro), and should be left as is until the pre1.2 update cycle.
> > Also, maybe look at adding an FAQ or Q&A type document. There are lots
>
> Ahem, there is a much ignored FAQ in the documentation. It even points to
> Herb's site. Given that Herb's site is so good, but focussed a bit more on
> tips and tricks, I want the FAQ to cover the true FAQs, then point to
Now, let's define "true FAQ's" here, my approach to this has always been:
look at what the users of the product are asking about and answer those
questions in a FAQ document. The answers may be as simple as referring to
the main body of the documentation, or pointing to a web site.
> Herb's site for everything else. However, unless the FAQ ends up easily
> accessible on the LyX Web site, I fear it will never be of much use.
> Despite repeated requests to get it there, it has never been included ...
Okay, I think I see where we have a bit of confusion here. I think we are
looking at two different types of FAQ documents: one for people who are
looking for extremely general information (should I investigate this
product?) type people (which I think is what you are considering), while I am
looking at new users: those that have decided to try LyX, but haven't read
the documentation, and just want a quick answer / cross reference into the
documentation.
I see a place for both types of documents. And, I think you are right, a
document for people that are unfamiliar with LyX should be on the web site to
try and generate some interest.
> You've presented some good ideas. Anyone else care to weigh in? I suspect
> John W will have some strong thoughts on the matter - I'm not sure if he
> reads this list or not.
Well, given his level of work on the documentation, we should possibly point
out what we are looking at / considering to him, and see if he has any
reaction.
--
George J. De Bruin
Check Out 0l0rin's New Age compositions at http://mp3.com/0l0rin
0l0rin's latest recording "Collection" is available now!
