Path: utzoo!utgpu!news-server.csri.toronto.edu!mailrus!ames!haven!decuac!e2big.mko.dec.com!bacchus.pa.dec.com!decwrl!uunet!mcsun!ukc!pyrltd!root44!praxis!itcp From: itcp@praxis.co.uk (Tom Parke) Newsgroups: comp.software-eng Subject: Re: Amount of Design Documentation Message-ID: <5280@newton.praxis.co.uk> Date: 9 Aug 90 13:06:48 GMT References: Organization: Praxis, Bath, UK Lines: 48 Dean_Thompson@TRANSARC.COM writes: >Based on your experience, how much design documentation do you think should >be done before coding starts? Consider the following levels: >"high level" -- Describe important algorithms and data structures. List the > modules with a short prose description of what each will do. >"module level" -- In addition, give an exact interface for each module. >"detail level" -- In addition, describe the important algorithms and data > structures for each module. Use psuedocode when it is the > best way to clearly describe the intended implementation. Whoa, this is all implementation. What you need to do depends on the context. Who is for, your self, your friends, your company, for sale, for a client? How big is it? How many people will be writing it? How many versions will there be? How safe and reliable does it have to be? How long will it last. How long will it last really :-). Are you experienced in the technology (hardware, operating system, language, development environment) to be used in the implementation? If the software is for somebody else (they're paying for it) how much do they understand computers and software? How much do you understand their business? Remember never assume immaculate conception, everything you do is to try and find where you are going wrong as soon as you can :-). Tom -- Tom Parke (my opinions and spelling are strictly temporary) itcp@praxis.co.uk Praxis, 20 Manvers St., Bath BA1 1PX, UK