[kde-doc-english] Documentation Format

[Antonio Salazar]

Interestingly enough, the information about writing documentation
isn't at http://docs.kde.org but rather at http://i18n.kde.org/

Specifically, http://i18n.kde.org/docs/ . There's a documentation
primer, a style guide, and a docbook quick reference.

Hope that helps!
Antonio

On Mon, Apr 14, 2008 at 9:15 AM, Mark Shelby <mshelby1 at gmail.com> wrote:
> Well, I am going to assume that
>
>  a) either everyone associated with kde-doc-english is very busy
>  writing for 4.0 or
>  b) No one seems to want to step forward and assume leadership of this group.or
>  c) Everyone is on vacation/holiday...
>
>  Either way, I'll just throw out the questions I have and hope that
>  someone can answer them. I ask them in the hope that someone can point
>  me in the direction of being a productive member of the group.
>
>  1) How does one start writing documentation? I looked on the
>  "techbase" website, but the info there is a little sketchy. Techbase
>  talks about using "EBN" to check your documentation once it's written,
>  but there don't seem to be any documentation suggesting:
>               a) What software to use to write the documentation
>               b) What format / template the documentation needs to follow
>               c) What to do with the documentation once it's written.
>
>  2) Shouldn't there be a page devoted solely to the development of
>  kde-documentation? I've seen the wonderful page at http://docs.kde.org
>  that allows you to search documentation, but that page needs to be
>  combined with the info on the main documentation page on
>  http://www.kde.org/documentation.
>
>  3) One of the reasons I love KDE is because of it's consistency of
>  'look & feel' across the spectrum of the user interface. Unless I am
>  missing something, I don't see the same continuity in kde
>  documentation. There should really be an app (maybe in koffice?) which
>  allows one to write documentation (or suggested revisions) and upload
>  it to the kde-doc team for review and inclusion in kde releases and
>  updates. That app should include some type of template for writing
>  documentation.
>
>  4) Maybe one should have the option to never download documentation,
>  but view it online from within the kde helpcenter.
>
>  I think more people would contribute if the process were made more simple.
>
>  Look at me, I am trying to contribute but can't really seem to get
>  answers on even where to start.
>  I have been trying to get involved for a week now. Someone really
>  should have contacted me indiviidually by now and told me what tools I
>  needed and assigned me a document to edit and submit for
>  consideration.
>
>  I as a new member to this group, I certainly don't mean to rant, but
>  these 'new' observations from a fresh perspective might just help the
>  doc team improve in what has to be a thankless task.
>  _______________________________________________
>  kde-doc-english mailing list
>  kde-doc-english at kde.org
>  https://mail.kde.org/mailman/listinfo/kde-doc-english
>



-- 
A handful of patience is worth more than a bushel of brains.

I'm a card-carrying member of the American Civil Liberties Union and
encourage you to join! Check out http://www.aclu.org/, become a member
at http://www.aclu.org/join and get active at
http://www.aclu.org/action.