[jitsi-dev] FAQ copy editing


#1

Below are a few more suggested corrections to the website. For now I've limited myself to grammar changes only. But it might be worth considering creating a user-oriented FAQ that limits jargon and covers general questions, and a creating a separate developer or "get involved" FAQ that covers more technical topics like submitting patches, etc.

A simple example of unnecessary jargon is the question "Is there a port of Jitsi for 'Android'?" It could be written as "Can I run Jitsi on Android phones?" A more extreme example of jargon is the explanation of "Why does my call stay in the 'Initiating Call' status and I can never connect?" https://jitsi.org/index.php/Documentation/FAQ#fragmentation

FAQ
https://jitsi.org/index.php/Documentation/FAQ

page reads: "we picked the name mainly because it was short and sounded well."
should read: "we picked the name mainly because it was short and sounded *good*."

page reads: "First of all you�ll need to email directly the development list"
it sounds more natural to me to move the word "directly" after "development list": "First of all you�ll need to email the development list directly and describe in detail what new feature you want to see in Jitsi"
Preferably you could simplify the whole sentence: "Send an email to the development list with a detailed description of the requested feature."

page reads: "you would like be asked to open a ticket"
page should read: "you would *likely* be asked to open a ticket"

page reads: "use IRC at irc.freenode.net, channel #sip-communicator."
page should read: "use IRC at irc.freenode.net, channel #jitsi."

page reads: "This can if you are using UDP"
page should read: "This can *happen* if you are using UDP"

page reads: "This is what happens when client support multiple features ;). "
page should read: "This is what happens when *a* client *supports* multiple features ;). "

page reads: "retrieve a part or its entire configuration"
page should read: "retrieve *part or all its* configuration"

page reads: "codecs we use, the features that users can manually configure and even protocol accounts."
sentence needs to standardize on second or third person (or avoid them both): "codecs, Jitsi configurations and even protocol accounts."

page reads: 'Is there a port of Jitsi for �Android� ?'
page should read: 'Is there a port of Jitsi for �Android�?' (delete the space before the question mark, per English grammar)

David


#2

Hey David

Thanks for your suggestions, I incorporated them to the FAQ.

Regards,
Ingo

···

-----Original Message-----
From: David Bolton [mailto:davidkbolton@gmail.com]
Sent: Mittwoch, 9. Januar 2013 06:27
To: Jitsi Developers
Subject: [jitsi-dev] FAQ copy editing
Below are a few more suggested corrections to the website. For now I've
limited myself to grammar changes only. But it might be worth
considering creating a user-oriented FAQ that limits jargon and covers
general questions, and a creating a separate developer or "get involved"
FAQ that covers more technical topics like submitting patches, etc.

A simple example of unnecessary jargon is the question "Is there a port
of Jitsi for 'Android'?" It could be written as "Can I run Jitsi on
Android phones?" A more extreme example of jargon is the explanation of
"Why does my call stay in the 'Initiating Call' status and I can never
connect?" https://jitsi.org/index.php/Documentation/FAQ#fragmentation

FAQ
https://jitsi.org/index.php/Documentation/FAQ

page reads: "we picked the name mainly because it was short and sounded
well." should read: "we picked the name mainly because it was short and
sounded *good*."

page reads: "First of all you'll need to email directly the development
list" it sounds more natural to me to move the word "directly" after
"development list": "First of all you'll need to email the development
list directly and describe in detail what new feature you want to see in
Jitsi" Preferably you could simplify the whole sentence: "Send an email
to the development list with a detailed description of the requested
feature."

page reads: "you would like be asked to open a ticket"
page should read: "you would *likely* be asked to open a ticket"

page reads: "use IRC at irc.freenode.net, channel #sip-communicator."
page should read: "use IRC at irc.freenode.net, channel #jitsi."

page reads: "This can if you are using UDP"
page should read: "This can *happen* if you are using UDP"

page reads: "This is what happens when client support multiple features
;). "
page should read: "This is what happens when *a* client *supports*
multiple features ;). "

page reads: "retrieve a part or its entire configuration"
page should read: "retrieve *part or all its* configuration"

page reads: "codecs we use, the features that users can manually
configure and even protocol accounts."
sentence needs to standardize on second or third person (or avoid them
both): "codecs, Jitsi configurations and even protocol accounts."

page reads: 'Is there a port of Jitsi for "Android" ?'
page should read: 'Is there a port of Jitsi for "Android"?' (delete the
space before the question mark, per English grammar)

David