Re: Editing a Design Doc.

Subject: Re: Editing a Design Doc.
From: Jane S Torpie <handson!boston -dot- handson -dot- com!janet -at- UUNET -dot- UU -dot- NET>
Date: Thu, 10 Nov 1994 13:53:00 PST

>Should a design document be written using the future
>tense "will" or the present tense "is, are" ?

If the design document is functioning as a statement
of the requirements, or as a pattern or roadmap for
development, I'd prefer future tense. This would be
most suitable for a larger or ore formal organizaiton
with division of labor & roles and lots of people to do
the work.

If the info in the design document will metamorphose
into the product documentation, I'd prefer present
tense (to simplify things). This would probably occur
in a smaller organization or one with few people, who
carry many roles.

Bottom line? If it's internal documentation, I wouldn't
worry about it ... you've probably got more pressing
business needs to handle...

Jane Torpie
janet -at- handson -dot- com

Previous by Author: Buying my Own Hardware
Next by Author: Re: First and Subsequent use of TM in doc
Previous by Thread: Editing a Design Doc.
Next by Thread: Re: Editing a Design Doc.

What this post helpful? Share it with friends and colleagues:

Sponsored Ads