Mailinglist Archive: yast-devel (157 mails)

< Previous Next >
Re: [yast-devel] YCP return bug?
  • From: Stefan Hundhammer <sh@xxxxxxx>
  • Date: Tue, 12 Jun 2007 12:02:24 +0200
  • Message-id: <200706121202.24879.sh@xxxxxxx>
On Tuesday 12 June 2007 11:08, Lukas Ocilka wrote:
> I guess, we could write more examples into the current documentation
> and/or write a chapter about "Standard building blocks" or something
> similar...
>
> Maybe we could "learn" how to document it from another documentation of
> another language...?

Actually, IMHO we need two kinds of documentation:

(1) Reference - concise, yet complete. But all by all means (unlike most man 
pages) with examples for the most common use cases.

(2) Tutorial - explanatory, not necessarily covering all aspects, 
concentrating on didactics, with pointers to the reference.


AFAICS we have only a subset of (1) and beginnings of (2).


CU
-- 
Stefan Hundhammer <sh@xxxxxxx>                Penguin by conviction.
YaST2 Development
SUSE LINUX Products GmbH, GF: Markus Rex, HRB 16746 (AG Nürnberg)
Nürnberg, Germany
-- 
To unsubscribe, e-mail: yast-devel+unsubscribe@xxxxxxxxxxxx
For additional commands, e-mail: yast-devel+help@xxxxxxxxxxxx

< Previous Next >