• Status: Solved
  • Priority: Medium
  • Security: Public
  • Views: 357
  • Last Modified:

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

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?
  • 3
1 Solution
Jacques Bourgeois (James Burger)PresidentCommented:
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.
dvplayltdAuthor Commented:
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.
dvplayltdAuthor Commented:
I found a solution on my own - it is VS 2008 Add Ins with name HyperAdd Ins
dvplayltdAuthor Commented:
This is a real solution to my needs, and to many other programmer too.
Question has a verified solution.

Are you are experiencing a similar issue? Get a personalized answer when you ask a related question.

Have a better answer? Share it in a comment.

Join & Write a Comment

Featured Post

Cloud Class® Course: Ruby Fundamentals

This course will introduce you to Ruby, as well as teach you about classes, methods, variables, data structures, loops, enumerable methods, and finishing touches.

  • 3
Tackle projects and never again get stuck behind a technical roadblock.
Join Now