Skip to Content.
Sympa Menu

comanage-dev - [comanage-dev] Documentation Style

Subject: COmanage Developers List

List archive

[comanage-dev] Documentation Style


Chronological Thread 
  • From: Benn Oshrin <>
  • To: comanage-dev <>
  • Subject: [comanage-dev] Documentation Style
  • Date: Sun, 09 Oct 2011 18:28:53 -0400

Well, at least this won't be about the number of spaces to indent.

Looking through Scott's updates to the installation page, I noticed the use of "we", as in "PHP will work with many different database servers but here we demonstrate how to test that PHP was built..."

I've generally been using third person for the documentation, so I'd rewrite this as

PHP will work with many different database servers. You can test that
PHP was built ... as follows ...

I actually don't like the familiar use of "you" in the documentation, but you might notice I've used it in quite a few places. So what I'd really want to write would be

PHP will work with many different database servers. It is possible
to test that PHP was built ... as follows ...

-Benn-



Archive powered by MHonArc 2.6.16.

Top of Page