design-documentation

Technical Design Documentation

What level of technical design documentation is good enough to get started with actual coding ? ...

How do you describe your solution/system?

I am about to write some standards/guidelines and templates that project managers, developers and business analysts would use. The goal would be to better understand the solution that is or was developed. One part of this is providing a standard/guideline on documenting the solution. E.g. documenting the piece of software which solves/...

Suggestions on how to organize Core Data visual layout?

Core Data is pretty amazing, and I've really enjoyed using the visual layout Xcode provides for it to organize things and get a quick sample of what data I've placed where. At times I've started to wonder if I'm making the best use of it, however, as after a while there tends to be such a mass of arrows that it becomes difficult to tell...

employe datbase management codings

i am doing a employee management project in dot net(c#,asp),where will i get the uml diagrams for the reference ... please help me ... if i get the documentation of tat project it will be very useful please help me friends thank u ...

Should I document everyting in my method and test based on the documentation?

Hi all, here is my question, as an example suppose i have a method to convert some types. something like this: /// <summary> /// Convierte el valor del objeto especificado a un valor equivalente de {T}. /// </summary> /// <typeparam name="T">El tipo del valor a regresar.</typeparam> /// <param name="source"> /// Un objeto <see cref="str...

Is there a reason why we don't embed the design document for code in the source itself?

Couldn't we write the design documentation for source code within the source itself? I suppose like Doxygen but with the focus taken away from implementation towards design. Essentially (and rather excitingly) you have a nice big chunk of markdown at the end of your source file. Each time I create a new source file (and begin writing in...