List of documentation writers

[Charles]

Here is the list of volunteers who would like to help writing documentation. Please let us know if you are interested, be aware that writing good documentation requires a fair amount of time :)


Charles - charles [at] pcbsd [dot] org
[/*:m:0027e] Dracheflieger - dracheflieger [at] gmail [dot] com
[/*:m:0027e] Gerard - gerard [at] pcbsd [dot] org
[/*:m:0027e] Terry Poulin - tmprx79g [at] bellsouth [dot] net[/*:m:0027e]

[rodonn]

Do you have documented documentation standards?

(I know it sounds like a joke but I am actually serious :) )

[Charles]

Yes! :)
http://forums.pcbsd.org/viewtopic.php?t=5328

[TerryP]

Hmm....

[rodonn]

OK, it was dumb question but worth asking ;) 8)

[Charles]

As always said my grand-grand grandma: "Dumb questions are always worth asking".

[TerryP]

If some one assigns me a subject (not in advanced usage section) I'd be glad to put a page together.

[dracheflieger]

If some one assigns me a subject (not in advanced usage section) I'd be glad to put a page together.

I'm with Terry, tell my what you want and I will be glad to put something together. I will also be happy to proof-read anyone else's writing for 'speeling' and grammar. I'll be much more crititcal on those than my own posts :lol:

[TerryP]

Since no ones given me a job yet, I've started work on common tasks. After I test KPorts the first part should be done soon after. Do you want to include installing *UGH, YUCK*, Linux RPM/Deb's as well or any installs from source ?

I also could use some screen shots hehe.

[rodonn]

Remember to check for splash screens and the like for PBI versions of Programs..... That seems to be a common feature over looked...

[Gerard]

Guys,

Thanks for your offer to help us out. We have decided that at the moment we will be concentrating on finishing the Quick Guide so it can be shipped with v1.3 when that comes out. When the Quick Guide is completed we will update and expand the FAQ/Documentation.
(http://faqs.pcbsd.org)
So far, Charles has done the introduction of the Quick Guide (http://docs.pcbsd.org/guide/). I'd be grateful if those of you who want to write a short intro could let us know which subject you want to pick from below and I'll update it so we know who's doing what.

1. Introduction [Charles]
1. Welcome to PC-BSD
2. PC-BSD's cutting-edge features
3. Where can I get help?
4. Additional resources

2. Installation [Charles]
1. Requirements
2. Creation of the CD-ROM
3. Installation
4. Post-installation
5. Network configuration
6. Connection to the Internet
7. Troubleshooting

3. Workspace [Gerard
1. Applications
2. K Control Center

4. Common tasks [TerryP]
1. Installing applications
2. Adding new users
3. Adding custom fonts
4. Downloading system updates
5. Printer setup
6. Disk naming convention and file permissions

5. System [DracheFlieger]
1. System information
2. System utilities

6. Advanced usage
1. Adding Hardware
2. Internet Connection Sharing (NAT)
3. Firewall configuration

If you think we should add to/change any of the above headings, please let us know.

GUIDELINES / SUGGESTIONS:
- this Quick Guide is most likely going to be put on the user's desktop during installalation, so when it's all done he/she can have a quick read through
- please write with a non-geeky end-user in mind. We're not writing a intro for hackers but for the casual Windows user. So keep it easy and plain.
- have a quick look at Charles Introduction for inspiration
- pictures & screenshots are all welcome
- please use US English, i.e. summarize instead of summarise etc
- you can write the intro in any format and email it to either Charles or myself and we'll take care of the final formatting

Many thanks in advance. Any queries, please let us know.

EDIT: assingned tasks and changed UK English to US English

[Gerard]

Here is the list of volunteers who would like to help writing documentation. Please let us know if you are interested, be aware that writing good documentation requires a fair amount of time :)


Charles - charles [at] pcbsd [dot] org
[/*:m:1359c] Gerard - gerard [at] pcbsd [dot] org[/*:m:1359c]

If you haven't done yet, and if you have some spare time for writing some documentation/howto's etc, it may be usefull to subscribe to the new Documentation Mailinglist (pcbsd-docs@googlegroups.com) or visit the Google Groups PC-BSD Doc site (http://groups.google.com/group/pcbsd-docs).

[TerryP]

I'm currently working on Common Tasks, I just think we should stick printer setup in some where and whose common task is adding fonts lol...

Also a thing about the file structure and permissions, basic to tell them there is no C:\ D:\ and E:\ e.t..c and about Super User/Regular User and RWXs hould go some where or direct them to the "GeekyBSD Handbook" (not funny imho, but eh I tried joking at a book I love).

[Charles]

For me it's no problem to write in UK English, but I thought US English was more appropriate because most people who use PC-BSD are either more used to US English (that you see everywhere on the web), or because they are Americans. Plus, most computer books and material on the web are written in US English :roll:

[dracheflieger]

Put me down for #5, System Information and Utilities.

[rodonn]

For me it's no problem to write in UK English, but I thought US English was more appropriate because most people who use PC-BSD are either more used to US English (that you see everywhere on the web), or because they are Americans. Plus, most computer books and material on the web are written in US English :roll:

Just because a lot of people do it doesn't make it correct, merely common... :evil:

[antik]

For me it's no problem to write in UK English, but I thought US English was more appropriate because most people who use PC-BSD are either more used to US English (that you see everywhere on the web), or because they are Americans. Plus, most computer books and material on the web are written in US English :roll:

Just because a lot of people do it doesn't make it correct, merely common... :evil:

What is the difference between American and British english?

[rodonn]

Things like Colour (UK) as opposed to Color(US)
Sceptic (UK) as opposed to Skeptic (US)

few grammatical things examples

gotten isn't common usage in UK English

a UK pavement is a US sidewalk


There are a few commonalities

Disk is used to describe computer disks, but not Compact Discs :)

Nothing really consistent

:roll:

[TerryP]

Years ago it was the same english at heart, years after it was still "english" but not the same.

It's just like how in the US allot of words are pronounced diffrently between North/South or how some things mean slightly diffrent things two or three states over. Even like my mom, she speaks Italion well, she learned from her Grandma now if she hears some one speaking a diffrent dialect she can't understand a lick of it.


Same thing, diffrent style.

[rodonn]

The languages split in the mid 1770s (quelle surprise)

The spelling significantly diverged in the 19th Century courtesy of Dr Webster of dictionary fame.

[Charles]

Terry and Dracheflieger, how is the documentation coming along? Do you need help? :)

[dracheflieger]

I always need help :lol: I had to leave to bury my last Aunt and drove over 5200 miles in the last 10 days so I'm a bit behind. I do have chap5 and 5.1 done...may want to rename 5.1 from System Information to PC-BSD Settings ;-). I could probably start now and write for a year on System Utilities so some feed back on what you want covered here would help. I emailed Gerard when I got in yesterday. I can email the files and pics...it's all from notepad, then kwrite to speel check. You should be able to just plug them in as I used the common headers/footers/class tags from the Quick Guide site...you'll have to replace the link pointers to the images but every thing else should slip in I think (it's been years since I produced a html page ;-) ) Let me know if you want them.

[goatman]

I can serve as a spell-checker if you need another one, American English, of course. But if you've got everything well in hand, that's great!!

[TerryP]

Do you make house calls?

[Charles]

Thanks! Well, if you find errors on our web site, documentation or software, please let us know!

[goatman]

Thanks! Well, if you find errors on our web site, documentation or software, please let us know! You got it! <{:D>

[goatman]

Do you make house calls? Nope! :lol: :lol:

[TerryP]

Doh ! Back to aspell/myspell

[jdarnold]

What is the difference between American and British english?

The old saying is "Two people separated by a common language." :wink:

[Solarin]

The differences between English & American English are quite considerable. They lie mostly on the grammatical front, and show how the two languages have moved apart since the British first emigrated to North America.

For example:
UK - Colour
USA - Color

The UKs 'ise' suffix is also generally seen as 'ize' in the US.

I don't think either party has difficultly understanding the other. It just allows for interesting academic arguments, and the need to maintain two sets of English dictionaries on computers :wink:

[Charles]

I think some expressions are more used in one country than another.
ie:

US / UK

I have a car / I have got a car
I have to read / I need to read

Etc...

[TerryP]

Theres also differences in slag, expressions, terminology e.t.c. Also I think one of my favorites is considered profanity in the UK but just rude in front of women folk in the US until the last few decades lol.

http://en.wikipedia.org/wiki/American_a ... ifferences (http://en.wikipedia.org/wiki/American_and_British_English_differences)

backpack / bergen
trunk / boot

e.t.c. IIRC.

[dracheflieger]

hood / bonnet
wrench / spanner

Spent a good deal of my youth mechanicing and street racing ;-) 1959 MGA 1500 with a Chevy 327 in it and nearly no floor boards...that was fun LOL..and a 1960 Austin Healy 100/6, both fine automobiles.

[goatman]

I don't think either party has difficultly understanding the other. It just allows for interesting academic arguments, and the need to maintain two sets of English dictionaries on computers :wink:
But look at this way Solarin .... the publishers of the various dictionaries (Websters/New Collegiate/Oxford/a_dozen_others_ whose_names _shall_ be_withheld), keep getting richer and richer :lol: :lol:
And that just the ones on our side of the pond :!: :!: :lol: :lol: :lol:

[TerryP]

I don't remember what PC-BSD uses, US or UK but really it should be UK english I think. Maybe try to use a lot of K's

I submit 'kolourpaint' as an example :-)

[Charles]

I suggest letting Terry correcting the whole guide and change to what he things is best, ie:

Already :arrow: Oh ready
Something :arrow: Some thang
Should have :arrow: Should of
CDs :arrow: CD's
Isn't :arrow: Ain't
Dear User :arrow: Bro

Much more fun suddenly :P :D

[TerryP]

Hehehe :-)

I have more respect for C99 then I do US English :-P

[goatman]

Thanks a bunch for that Wiki link TerryP; :( :roll: :roll: :(
Now I gotta go to Dictionary dot com and find out what all these goofy words mean, then I'll have to get my English neighbor to translate the whole thing back to me so I know if they're dissing the Americans or not :lol: :lol: : Similarly, the pluperfect is occasionally replaced by the preterite in the U.S.; this is generally regarded as sloppy usage by those Americans who consider themselves careful users of the language. U.S. usage sometimes substitutes the conditional for the pluperfect ("If I would have cooked the pie we could have had it for lunch").

[JaceMan]

As I mentioned in the Networking forum I am a Technical Writer by trade. I would love to help out in any way I can. That being said, the amount of writing I'm able to complete is wedged against the success I have with getting wireless working on my laptop. As I travel about 60% of the time it would be most convenient if I'm actually able to work when not at home.

[fgibbs]

Hello,

I'd like to assist in writing documentation for the project. I'm fairly comfortable with the entire PC-BSD system, so feel free to put me anywhere you'd like: what I don't know, I'll simply learn. Thank you.

Cheers!

~fred

[Charles]

Thanks, please get in touch with Gerard (gerard_AT_pcbsd_D0T_org) ;)