No, it's not perfect English (Oxford, American, whatever… Standard {Written,White} English), but it makes its point clearly and concisely. Like a blog, it's still conversational (in a way technical documentation “shouldn't” be), but that isn't getting in the way of my understanding the content.
Yes, eAccelerator is easier to describe than the sprawling blob of PHP, but the fact that you're documenting a sprawling blob is no excuse to start writing like you stopped paying attention in English class during fourth grade.
(I note that this maybe sounds like I'm saying, “Speak English!” I don't mean to be. I'd have a harder time processing properly-written Italian or German, and I wouldn't have a prayer in French, Russian, Japanese, and so forth, but I would be completely lost if I were reading Italian or German as poorly written as the English PHP documentation. I have a feeling that someone for whom English was not a first language would be totally stymied by the English PHP documentation. That's simply unacceptable by any sane consumer of the product.)
Post a Comment