Off topic - software design document

  • Thread starter Thread starter Alan T
  • Start date Start date
A

Alan T

We are re-developing a legacy application would like to write some
documentation about testing.
eg.
Specifying the program title, modules, functions and screen shots for each
functions.
Any sample/template about that?

Thanks
 
We are re-developing a legacy application would like to write some
documentation about testing.
eg.
Specifying the program title, modules, functions and screen shots for
each functions.
Any sample/template about that?
Click to expand...

If you are talking automated testing, I tend to set up unit tests with a
testing framework and XML comments. It is not perfect, but you can
easily set up a check in rule for XML comments (depending on the source
repository used) and force the dev to write something. ;-)

The above works very well with Test Driven Development (TDD).

If you are talking manual tests or QA tests, the rules change a bit as
documentation in code cannot easily be used to generate documentation
for these types of tests.

Peace and Grace,


--
Gregory A. Beamer
MVP; MCP: +I, SE, SD, DBA

Twitter: @gbworld
Blog: http://gregorybeamer.spaces.live.com

My vacation and childhood cancer awareness site:
http://www.crazycancertour.com

*******************************************
| Think outside the box! |
*******************************************
 
If you are talking manual tests or QA tests, the rules change a bit as
documentation in code cannot easily be used to generate documentation
for these types of tests.
Click to expand...

Yes, that's manual tests.
We would like to divide the application into sections (modules).
This will serve two-fold: tests and help doc.

I would like to have a format of that document to put our stuffs in that
template. I guess that will be the job of business analysts or someone.
 
Yes, that's manual tests.
We would like to divide the application into sections (modules).
This will serve two-fold: tests and help doc.

I would like to have a format of that document to put our stuffs in that
template. I guess that will be the job of business analysts or someone.
Click to expand...


You can lead a developer to water, but you can't make him write test
documentation. ;-)

Peace and Grace,

--
Gregory A. Beamer
MVP; MCP: +I, SE, SD, DBA

Twitter: @gbworld
Blog: http://gregorybeamer.spaces.live.com

My vacation and childhood cancer awareness site:
http://www.crazycancertour.com

*******************************************
| Think outside the box! |
*******************************************
 
Back
Top