[opensuse-doc] help writing a how to document
Guys, I am keen to write a how to but need a bit of help getting started. Can anyone help me out with the following questions: - What are some easy tools to write it in - What format does it need to be in - How do I get the style right - How do I get it reviewed - How do I submit it to the opensuse site There is some good info on the opensuse site but I cant get the answers to all of these questions. Thanks in advance, Michael. -- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-doc+help@opensuse.org
Hi Michael,, On Monday 24 November 2008, Michael Moore wrote:
I am keen to write a how to but need a bit of help getting started.
A howto in the openSUSE Wiki or a howto for Lessons for Lizards? I'm not completely sure from your mail. Therefor the following answers maybe a bit vague.
Can anyone help me out with the following questions:
- What are some easy tools to write it in
Well, that depends on how you define "easy". Some people wouldn't say DocBook is easy, others agree. :) If you want to write in DocBook XML, use the following URL to get an overview: http://wiki.docbook.org/topic/DocBookAuthoringTools
- What format does it need to be in
This is a matter of what end format you need. In case of DocBook you write it in DocBook XML (and only in this format) and transform it into other formats, be it PDF, (X)HTML, Manpages, and others. Even for EBooks now. If you are only interested in a good-looking book and know you will never ever want to have it as HTML, I would prefer LaTeX.
- How do I get the style right
For our docs we use the following styleguide: http://forgeftp.novell.com//opensuse-style/documentation.pdf
- How do I get it reviewed
Maybe ask on this mailinglist? :)
- How do I submit it to the opensuse site
Depends. If you write in the openSUSE Wiki you need to press the save button. ;) If you want to write more for Lessons for Lizards you need an openSUSE account and write permissions to our public SVN.
There is some good info on the opensuse site but I cant get the answers to all of these questions.
Here is the FAQ of the Lessions for Lizards project, if you haven't found them yet: http://developer.novell.com/wiki/index.php/Lfl/Lessons_for_Lizards_FAQ Hope that answers some of them. :) Tom -- Thomas Schraitle ---------------------------------------------------------------------- SUSE LINUX GmbH >o) Documentation Specialist Maxfeldstrasse 5 /\\ 90409 Nuernberg _\_v http://en.opensuse.org/Documentation_Team http://developer.novell.com/wiki/index.php/Lessons_for_Lizards http://lizards.opensuse.org/author/thomas-schraitle/ --------------------------------------------------------------------- -- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-doc+help@opensuse.org
Thomas, I am aiming to write a how to for the opensuse wiki. So I guess that means no DocBook for me yet. All I have to do is create a wiki page. Thanks.
Hi Michael,,
On Monday 24 November 2008, Michael Moore wrote:
I am keen to write a how to but need a bit of help getting started.
A howto in the openSUSE Wiki or a howto for Lessons for Lizards? I'm not completely sure from your mail. Therefor the following answers maybe a bit vague.
Can anyone help me out with the following questions:
- What are some easy tools to write it in
Well, that depends on how you define "easy". Some people wouldn't say DocBook is easy, others agree. :) If you want to write in DocBook XML, use the following URL to get an overview:
http://wiki.docbook.org/topic/DocBookAuthoringTools
- What format does it need to be in
This is a matter of what end format you need. In case of DocBook you write it in DocBook XML (and only in this format) and transform it into other formats, be it PDF, (X)HTML, Manpages, and others. Even for EBooks now. If you are only interested in a good-looking book and know you will never ever want to have it as HTML, I would prefer LaTeX.
- How do I get the style right
For our docs we use the following styleguide:
http://forgeftp.novell.com//opensuse-style/documentation.pdf
- How do I get it reviewed
Maybe ask on this mailinglist? :)
- How do I submit it to the opensuse site
Depends. If you write in the openSUSE Wiki you need to press the save button. ;) If you want to write more for Lessons for Lizards you need an openSUSE account and write permissions to our public SVN.
There is some good info on the opensuse site but I cant get the answers to all of these questions.
Here is the FAQ of the Lessions for Lizards project, if you haven't found them yet:
http://developer.novell.com/wiki/index.php/Lfl/Lessons_for_Lizards_FAQ
Hope that answers some of them. :)
Tom
-- Thomas Schraitle
---------------------------------------------------------------------- SUSE LINUX GmbH >o) Documentation Specialist Maxfeldstrasse 5 /\\ 90409 Nuernberg _\_v http://en.opensuse.org/Documentation_Team http://developer.novell.com/wiki/index.php/Lessons_for_Lizards http://lizards.opensuse.org/author/thomas-schraitle/ ---------------------------------------------------------------------
-- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-doc+help@opensuse.org
participants (2)
-
Michael Moore -
Thomas Schraitle