Skip to Content.
Sympa Menu

comanage-dev - Re: [comanage-dev] Documentation Style

Subject: COmanage Developers List

List archive

Re: [comanage-dev] Documentation Style


Chronological Thread 
  • From: Scott Koranda <>
  • To: Benn Oshrin <>
  • Cc: comanage-dev <>
  • Subject: Re: [comanage-dev] Documentation Style
  • Date: Sun, 9 Oct 2011 18:58:07 -0500

> 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 ...
>

Fortunately it is a wiki, so you can wordsmith at that level
of detail yourself. ;-)

As for style, I prefer active phrases ala Strunk and White, so
I always write "You can do..." instead of "It is possible to
do...".

Cheers,

Scott



Archive powered by MHonArc 2.6.16.

Top of Page