(English) Help File Rewrite

[Killswitch]

It's been mentioned before in a couple of places, but the English help files could really do with a bit of a polish to make them more user friendly and understandable for newbies.

Not that I'm an expert or anything, but I'm willing to go through and rewrite the helpfiles myself - and I'm sure there are lots of other forum members willing to lend a hand. We'd just need access to the .html files for editing.

(We all know writing the help file is the most tedious part of any project, so this could take the weight off the PB team).

[mskuma]

I think the help is basically quite good - maybe some parts need some rewriting for clarity. I think in some places it really does need editing for spelling/grammar correction. The help file particularly needs reindexing, and ideally (at times) links to anchored paragraphs to help home in on the precise material, rather than just point to a page in general. I'd be willing to help out, but first I'd like to make sure the best (ideally free) help tool is used - since this will make the job easier for those involved. I think help tools has been raised before on this forum.

[Killswitch]

You've hit the nail on the head. They just need a through edit to make them, as you say, clearer.

[Kale]

Im sure if you ask nicely you might get access to the doc CVS. From there you can polish all you want.

This has been ask for before and access was granted, but nothing was actually done by community members. It's a lot of work, just remember that.

[freak]

The PB documentation is quite good actually considering that we do not have a paied team working fulltime on it.
In fact, there are much worse ones out there. (anyone tried the gtk docs? )

Im sure if you ask nicely you might get access to the doc CVS. From there you can polish all you want.

This has been ask for before and access was granted, but nothing was actually done by community members. It's a lot of work, just remember that.

Yes, access to the documentation cvs is possible. Just contact Fred directiy and ask for it.

There were some people who did that in the past, but most did not contribute that much
because they realized that PB's documentation is a far bigger task than they expected

We do have a user editing quite actively editing the french docs recently though.

[Fred]

Waiting for mails .

[mskuma]

Mail has been sent - Killswitch & I will give it a go.

[blueznl]

you are allowed to copy sections of the survival guide if you want

[Trond]

It's been mentioned before in a couple of places, but the English help files could really do with a bit of a polish to make them more user friendly and understandable for newbies.

Well, I'd rather have a separate polish help file than put the polish into the english one. :roll:

[traumatic]

[Killswitch]

Ok, my spelling isn't fantastic but I'll take a lot more care with the help files.