I just took a quick look at the style guide, and I was quite impressed with the 
amount of good, basic writing guidance it provides. I think you raise a good 
question about whether this is relevant to all the various forms of 
documentation available today. All-in-all, I think this style guide applies. In 
general, blogs and wikis are "less formal," and I think it's appropriate that 
the writing style should follow suit. Note, unless I missed it, I did not see 
any rules in the style guide against using first-person pronoun (I). That is 
often a rule in more formal technical documentation that depersonalizes the 
communication. I admit, I've recently come from an environment where we treated 
technical content more like web-zine material than technical documentation 
(here's an example, 
http://www.cassatt.com/infocentral/collage/5.1/docs/NetworkingCalculatingIPs/index_PEDCE.php),
 so I've become use to writing in an informal tone. Where this is precarious 
for something like OpenSolaris is when too much jargon sneaks in and 
complicates translation or communicating to  an international audience. 

-alan
 
 
This message posted from opensolaris.org

Reply via email to