Mailinglist Archive: opensuse-doc (50 mails)

< Previous Next >
Re: [opensuse-doc] Online Manual input source
  • From: Thomas Schraitle <thomas.schraitle@xxxxxxx>
  • Date: Tue, 15 May 2007 16:48:54 +0200
  • Message-id: <200705151648.54881.thomas.schraitle@xxxxxxx>
Hi Hylton,

On Dienstag, 15. Mai 2007, Hylton Conacher (ZR1HPC) wrote:
>
> Sorry for the delay in replying.

Not a problem. :)


> > On Dienstag, 8. Mai 2007, Hylton Conacher (ZR1HPC) wrote:
> >>> Have you looked into the Lessons for Lizards project?  It might
> >>> be an excellent way to get the information you consider
> >>> important into an easily-accessible format.....
> >>
> >> I have, and find that it is not categorised and as structured as
> >> I would have expected and the menu is faar too long as I am
> >> almost sure many of the subheadings could be grouped under a
> >> single parent heading.
> >
> > We have started it only a few months ago so it takes time
> > everybody get used to it. It might look a bit unbalanced.
>
> OK, although I think with a better structure of what topics ned
> writing on would be better as then writers can choose and be
> allocated to a writing/contributing to a task.

We have a template that each topic should use, see here:
https://forgesvn1.novell.com/svn/lfl/trunk/common/xml/topic-template.xml

The idea was to create chapters that deal with certain topics like 
Installation, Networking, System Administration, etc. If someone 
writes a topic it is easier to include it under an available 
category. 

I think the structure of the above template should be sufficient for 
many topics. Do you think there is anything missing?


> > Do you have something special in mind? I am very interested in
> > listing to your suggestions. Could you elaborate your ideas a bit
> > more? Is it the structure itself or the content of some articles,
> > or anything else?
>
> Thank you for taking the time to listen.
> As I said earlier, I think it is the structure itself. The online
> book/manual is going to be an ever changing and growing, so readers
> need to know where to look for help on the problem they are
> experiencing, as opposed to having to basically scour the whole
> manual.

Ok. Do you have an example that illustrates your problem? I am not 
sure if I understand your issue completely. 


> > [...] For more details look here:
> >
> >   http://developer.novell.com/wiki/index.php/Lfl/Tasks
>
> I had a look and seem to fit in as a designer but more for the
> layout/structure of the LFL book.

If you want to improve the stylesheets or need a place for your ideas 
I can give you access to the Subversion repository. Send me a private 
mail with your login name.


> [...]
>
> Well I think i would be more use in helping design the base
> structure or Contents that the various writers are  going to write
> articles for. With the structure in place it can also give the
> writer a little guidance on how technical or newbie they have to
> write.

Everybody can participate in this project. In the end there should be 
consensus of what you propose. You can write a "Request for 
Improvements" and discuss it with others here on this mailinglist. :)


> > [...]
> >
> > Thanks for asking! :-)
>
> Sorry, What did I ask ? :)

Well, that was a over-simplification on my side. :-)


Bye,
Tom

-- 
Thomas Schraitle

----------------------------------------------------------------------
SUSE LINUX GmbH      >o)   Documentation Specialist
Maxfeldstrasse 5     /\\   
90409 Nuernberg     _\_v   http://en.opensuse.org/Documentation_Team
---------------------------------------------------------------------
To unsubscribe, e-mail: opensuse-doc+unsubscribe@xxxxxxxxxxxx
For additional commands, e-mail: opensuse-doc+help@xxxxxxxxxxxx

< Previous Next >