Documenting Business logic

Documenting Business logic

Old forum URL: forums.lhotka.net/forums/t/10920.aspx


kevinsky posted on Saturday, November 26, 2011

I have to add a new module to a complex .Net  web application written in C#.  It is used in a case management system and the module manages cases that are even more complex than the existing application.

One of the weaknesses of the existing system is that the business logic can only be seen in the code.  I went through the Sandcastle thing and produced almost a gigabyte of MSDN style documentation that no manager would ever understand.

I hope to use .Net 4,CSLA and Codesmith to  help with the module.  What can they do to show the business logic in simple sentences?  Are there decision tables or should I go with custom xml comments?

Thanks for all ideas

 

Copyright (c) Marimer LLC