How/which software tool you use to document your projects?

Posted on 2012-09-16
Medium Priority
Last Modified: 2012-12-10
Dear experts

I should document a BIG project with C#, MS SQL Server 2008 . I need to document both the logic and the relations between different parts of solution, they works on different computers communicating via Internet and it is really complicated system. What solution, which software tool you will recommend me for this case? I do not need to documents in details code, classes and SQL Database, I need a solution which to give idea to the developer team which part should be modified to add a feature.

 For now, I intend to use MS Visio ..but it is not so good solution. Please share your experience.

And, I’m especially interesting of tool which are able graphically to represent objects and when I click over this objects to be able to navigate to VS 2008 code. I want to do this on my own, for partical objects only, for all objects because it become too complex … Is there Add Ins for Visio which are able to navigate in VS to specific code?
Question by:dvplayltd
  • 3
LVL 40
ID: 38403234
There is such a tool built in all versions of Visual Studio except the Express. The Class Designer.
Not only will it enable you to see the structure of your project, it can also be used to generate code for new properties and methods while you are working on the design.

In order to use it in an already created project, go Project...Add New Item...Class Diagram.

Then from the Solution Explorer, drag your project onto the designer surface. Et voilà.

Right clicks on the surface and on the classes enables you to add elements, and the designer automatically generates the stub of code for the element.

Author Comment

ID: 38408391
Well, i know about the Class Diagrams .. but it is not very useful. I do not see any option to draw my labels, relations with arrows and so no ... again - my idea it not detail documents for all properties and methods, it is general description in which i should include Database too ... so when developer face with a problem to see all parts of the solution which should be changed ...

 In short, i need a tool on which to draw free, like Visio, but if i have navigation options /to redirect to code in VS/ will be great.

Accepted Solution

dvplayltd earned 0 total points
ID: 38665069
I found a solution on my own - it is VS 2008 Add Ins with name HyperAdd Ins

Author Closing Comment

ID: 38675262
This is a real solution to my needs, and to many other programmer too.

Featured Post

What is SQL Server and how does it work?

The purpose of this paper is to provide you background on SQL Server. It’s your self-study guide for learning fundamentals. It includes both the history of SQL and its technical basics. Concepts and definitions will form the solid foundation of your future DBA expertise.

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

This document covers how to connect to SQL Server and browse its contents.  It is meant for those new to Visual Studio and/or working with Microsoft SQL Server.  It is not a guide to building SQL Server database connections in your code.  This is mo…
Wouldn’t it be nice if you could test whether an element is contained in an array by using a Contains method just like the one available on List objects? Wouldn’t it be good if you could write code like this? (CODE) In .NET 3.5, this is possible…
Exchange organizations may use the Journaling Agent of the Transport Service to archive messages going through Exchange. However, if the Transport Service is integrated with some email content management application (such as an anti-spam), the admin…
As many of you are aware about Scanpst.exe utility which is owned by Microsoft itself to repair inaccessible or damaged PST files, but the question is do you really think Scanpst.exe is capable to repair all sorts of PST related corruption issues?
Suggested Courses
Course of the Month15 days, 2 hours left to enroll

839 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question