[rules-dev] When (re)writing docs, know about the language guidelines

Geoffrey De Smet ge0ffrey.spam at gmail.com
Mon Aug 9 08:47:47 EDT 2010


If you write or rewrite docs, it might be interesting to quickly read 
the language guidelines of the JBoss documentation guide, chapter 7:
 
http://hudson.jboss.org/hudson/job/JBoss_Documentation_Guide/lastSuccessfulBuild/artifact/JBoss_Documentation_Guide/target/docbook/publish/en-US/pdf/JBoss_Documentation_Guide.pdf

It contains stuff like "use active voice", "avoid future tense", ...
and it's not that long (that chapter at least :)

-- 
With kind regards,
Geoffrey De Smet



More information about the rules-dev mailing list