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

Posted on 2012-09-16
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
    LVL 40

    Expert Comment

    by:Jacques Bourgeois (James Burger)
    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

    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

    I found a solution on my own - it is VS 2008 Add Ins with name HyperAdd Ins

    Author Closing Comment

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

    Write Comment

    Please enter a first name

    Please enter a last name

    We will never share this with anyone.

    Featured Post

    What Is Threat Intelligence?

    Threat intelligence is often discussed, but rarely understood. Starting with a precise definition, along with clear business goals, is essential.

    In my previous article ( we saw the basics of serialization and how types/objects can be serialized to Binary format. In this blog we wi…
    More often than not, we developers are confronted with a need: a need to make some kind of magic happen via code. Whether it is for a client, for the boss, or for our own personal projects, the need must be satisfied. Most of the time, the Framework…
    Migrating to Microsoft Office 365 is becoming increasingly popular for organizations both large and small. If you have made the leap to Microsoft’s cloud platform, you know that you will need to create a corporate email signature for your Office 365…
    This video is in connection to the article "The case of a missing mobile phone (". It will help one to understand clearly the steps to track a lost android phone.

    758 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

    Need Help in Real-Time?

    Connect with top rated Experts

    11 Experts available now in Live!

    Get 1:1 Help Now