|
.Writing a specification for the
first time may seem a daunting task. However if you follow
these simple guidelines the result should be quite sufficient
for a fixed price quotation:
- If you’re going to use terminology specific to
a particular field include a glossary.
- Please incorporate a method of identifying the latest
version of a document e.g. a revision number.
- Many products will need a user guide and/or installation
manual. Often these are written last; instead consider writing
them first – they will reveal a lot about the product.
- If using MS Word, consider using Styles as this will
enable:
- Automatic generation of a Table of Contents.
- Section cross-references that update automatically.
- Convenient document navigation via the Document Map.
- Consider what acceptance tests will be required to check
the product conforms to the specification.
- Use natural language to describe what the product is
to do:
- Avoid complex flow-charts; these do not define the
problem; rather they describe one particular solution.
- A common pitfall with follow-on products is to include
the techniques used in previous generations as part
of the specification for subsequent generations. However,
as both engineering practices & technology are constantly
evolving, this can stifle innovation.
- It may seem obvious but don’t describe a product
in terms of previous products unless they are familiar
to all interested parties.
- Include any of the following that you’re aware
of:
- Relevant standards.
- Direct competitors.
|
