On Tue, Mar 09, 2010 at 10:05:06AM +1000, Russell Dickenson <[email protected]> wrote: > As I am reviewing existing documentation and writing GFpm's > documentation (s--l--o--o--w--l--y) I am also writing a Frugalware > documentation style guide. I am using documents such as the GNOME > Style Guide as inspiration but not wanting to copy them completely. > > In doing this I am wondering if in documentation, perhaps also the > newsletter, contractions should be avoided? Contractions are English > words which are a shorter version of two words - for example - > "they're" instead of "they are", "who's" instead of "who is". I have > no idea to what level English is understood in the various countries > around the world so I am asking for help from those for whom English > is a second language. Although English is my native and only language, > I am certainly not an expert. On a visit to my daughter's school > yesterday I saw a poster which gave help on a part of English which I > had never heard of before. In fact I have just Googled it to expand my > knowledge of my own language! :P
The documentation we write is not a literature work, it's a technical documentation. I think it's ok if you start avoiding "it's" in favor of "it is", but forcing everybody to write FW documentation in this style is a step towards http://simple.wikipedia.org/ ;) > (ryuo, if you are reading this, no > jokes please!) :D
pgpg0QCdfhUZ7.pgp
Description: PGP signature
_______________________________________________ Frugalware-devel mailing list [email protected] http://frugalware.org/mailman/listinfo/frugalware-devel
