Hello Koen,

Thursday, January 10, 2008, 12:27:47 PM, you wrote:

[]

> My not so strong opinion on these changes is that they can stay as is,
> with links added to the relevant debian networking docs and the msdn
> site for windows ICS.

  Btw, I was thinking about adding good links for terms too. But
IMHO, Wikipedia should be the first destination. Linking up Debian
docs would be nice too, hopefully will save lots of effort. As for
MSDN, someone should find relevant docs first, and links could go
abroke easily ;-).

> I'm a big fan of concise[1] documentation, but examples are usefull,
> provided:

> * they are clearly marked as 'examples' not 'gospel truth' or 'paste me'
> * they link to the long documentation and tutorials on how to do it "the
> right way"

> Again, it's just my not so strong opinion, and I don't actually
> contribute to the docs.

> |    I know that my latest additions themselves are not ideal - there's
> | a need to elaborate manual structure and section intros, because it
> | grows increasingly "jumpy" from topic to topic. But adding additional
> | choices for users to parse thru and random notes won't make it more
> | clear.
> |
> |    Btw, I already feel limits of manual-in-wiki, if there's going to
> | form a documentation team, we probably will need to setup an SCM and
> | some representation vs formatting framework.

> I've been thinking of proposing something like ikiwiki (like
> cairographics.org uses) with a (*gasp*) git backend to use for
> documentation. That way users can use their browser to edit it, while
> developers can use git to get diffs or a local copy and edit if offline.
> I haven't actually used it and hate git with a passion, but as I said, I
> don't actually contribute to the docs.

  Yep, that sounds chore to setup, who knows what to maintain. I guess
first choice would be using Docbook just as OE manual uses, and put
somewhere in MTN. But even that requires bunch of effort to settle it.
So, let's wait when people will grow wanting that well enough. But on
the other hand, it seems it's time to add screenshots to manual, and I
don't feel like go for that with wiki, as it will be chore to extract
them later, unlike text.



> regards,

> Koen


> [1] http://en.wiktionary.org/wiki/concise - brief and precise. The
> terse-maffia will probably label it as 'offensive', but I don't care.




-- 
Best regards,
 Paul                            mailto:[EMAIL PROTECTED]


_______________________________________________
Angstrom-distro-devel mailing list
Angstrom-distro-devel@linuxtogo.org
http://lists.linuxtogo.org/cgi-bin/mailman/listinfo/angstrom-distro-devel

Reply via email to