The following figure depicts and summarizes development workflow as discussed above.Īs SQL Server database development is a good candidate for code documentation, this development workflow applies and this article will focus on following steps: Note that a unneglectable step of this documentation process should be a regular review of existing documentation so that it stays up-to-date and reflects reality. If everything is done well, then we are sure that each version of a database solution that is distributed always contains documentation. For instance, a unit test that fails whenever an undocumented object is found could be created. In the best case, both of these processes should take documentation into account. It’s a complete process that should start no later than the end of every development task with other processes, like Code Quality Assessment and Testing. This would, of course, be made easier thanks to a good documentation of existing code.īut, documentation is not simply some document we can open when we need it.
In any good programming reference, you will read that a developer has to document his code, not only for him/herself but also for the person who, ten years later will be asked to maintain it.
0 kommentar(er)
