Documentation system - C# / C Sharp

Smokey Grindle

We are trying to find a system that would be good for a development team to
share documentation on our .net solutions throughout our company. Does
anyone know of any systems out there that are good for handleing information
such as lists of what's changed, whats being worked on, what documentation
was recently changed, and a way to browse documentation like a book maybe?
Im not talking about the inline documentation comments in the souce of
projects I mean a full featured documentation system... thanks!

Jan 4 '07 #1

Subscribe Reply

1742

Dave Sexton

Hi,

Sandcastle provides a compiled help file (.chm) for assembly documentation
in the MSDN format, including xml code comments:

Sandcastle - December 2006 Community Technology Preview (CTP)
http://www.microsoft.com/downloads/d...displaylang=en

Recently, I created an Add-In for Visual Studio 2005 that integrates
Sandcastle into the IDE using a C# project template. In other words, it
allows you to create a documentation project that, when built, creates a
single compiled help file for all of its project references:

http://www.codeplex.com/DocProject

You can use SharePoint to create a team portal where you can collaborate and
publish the latest documentation:

Windows SharePoint Services 3.0
http://www.microsoft.com/downloads/d...displaylang=en

Visual Studio Team System can be used to provide a development environment
geared towards teams with task assignment and tracking, a SharePoint team
portal and source control on a central Visual Studio Team Server. The Team
system has different flavors for various roles in an organization, such as
Developers, Database Administrators, Testers and Architects.:

Visual Studio Team System
http://msdn2.microsoft.com/en-us/tea...m/default.aspx

--
Dave Sexton
http://davesexton.com/blog

"Smokey Grindle" <no****@dontspa mme.comwrote in message
news:ux******** ******@TK2MSFTN GP06.phx.gbl...

We are trying to find a system that would be good for a development team
to share documentation on our .net solutions throughout our company. Does
anyone know of any systems out there that are good for handleing
information such as lists of what's changed, whats being worked on, what
documentation was recently changed, and a way to browse documentation like
a book maybe? Im not talking about the inline documentation comments in
the souce of projects I mean a full featured documentation system...
thanks!

Jan 5 '07 #2

Similar topics

2375

Documentation examples needed

by: Stuart D. Gathman | last post by:

I am still wanting to produce Python standard format documentation for Python extensions I have written. I have looked at the docs that come with Python itself, but I am new to Latex, and don't know how to add the document classes and styles from texinput for a new project. Is there a small project with documentation in the Python standard that I can use as an example? -- Stuart D. Gathman <stuart@bmsi.com>

Python

1478

PHP Documentation

by: Guyon Morée | last post by:

hi, I've been working with PHP lately and what I found is that the docs are awesome, as is the python are python docs btw. but one thing that I really like about theirs is the doc-commenting system it has. any user can comment on any page in the docs. this results in a lot of clarifications and examples for the subjects at hand. is it an idea to implement this in the python docs? i believe it's a good idea what are your thoughts?

Python

1906

Visual Studio - Documentation

by: PaulThomas | last post by:

WHY does the .Net Documentation show http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemwebsessionstatehttpsessionstatememberstopic.asp .NET Framework Class Library HttpSessionState Public Properties Item = = = Overloaded. Gets or sets individual session values. In C#, this property is the indexer for the HttpSessionState class. THEN using the MSDE example walkthrough: int intImageId =...

.NET Framework

3094

Better way to view C# API documentation

by: steve | last post by:

I found the .Net/C# API documentation included with Visual Studio .Net 2003 and on MSDN. I don't like the layout. I would like to use something close to the javadocs that are available for Java. Where I can see a complete list of classes. With the included docs you have to dig around the documentation to find what you need. For instance, the System.Object is not on the top level of documentation as are all the other System.* classes. you...

C# / C Sharp

7741

XML Comment documentation

by: WALDO | last post by:

Where can I find some documentation on creating XML comment files. I would like to know the format/conventions for creating them.

Visual Basic .NET

1037

XML Documentation

by: Ben Crinion | last post by:

Hi Im using ASP.NET 2 with C# in codebehind files and Visual Studio 2005 Team Edition. I have embedded lots of XML Documentation (<summary>,<see>,etc) into my ASP.NET project in code behind files of ASP pages, user controls and classes in the App_Code directory. I have added the "/doc" compiler option using the web.config (see snippet at bottom of post).

ASP.NET

2084

puzzled by VS2005 documentation generator

by: Tim_Mac | last post by:

hi, i have VS2005 professional, and i would like to generate a complete documentation reference for all the classes in my web project. i would have thought this was as simple as a button or build option? i have all the <summary> tags etc. ben crinion posted a similar question in march and it went unanswered. he was able to get the files documented for a single folder by adding some sections to his web.config. my site has tons of...

ASP.NET

2937

Pythondocs.info : collaborative Python documentation project

by: nicolasfr | last post by:

Hi, I am a bit disapointed with the current Python online documentation. I have read many messages of people complaining about the documentation, it's lack of examples and the use of complicated sentences that you need to read 10 times before understanding what it means. That's why I have started a collaborative project to make a user contributed Python documentation. The wiki is online here: http://www.pythondocs.info

Python

2197

General network error. Check your network documentation.

by: johnkamal | last post by:

Hi, Some times while opening a page, I am getting the following error message, Please help me to rectify the problem. Server Error in '/' Application. General network error. Check your network documentation. Description:An unhandled exception occurred during the execution of the current web request. Please review the stack trace for more information about the error and where it originated in the code. Exception...

.NET Framework

9599

Changing the language in Windows 10

by: Hystou | last post by:

Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it. First, let's disable language synchronization. With a Microsoft account, language settings sync across devices. To prevent any complications,...

Windows Server

10626

Problem With Comparison Operator <=> in G++

by: Oralloy | last post by:

Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. Here is my compilation command: g++-12 -std=c++20 -Wnarrowing bit_field.cpp Here is the code in...

C / C++

10372

Maximizing Business Potential: The Nexus of Website Design and Digital Marketing

by: jinu1996 | last post by:

In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven tapestry of website design and digital marketing. It's not merely about having a website; it's about crafting an immersive digital experience that captivates audiences and drives business growth. The Art of Business Website Design Your website is...

Online Marketing

10374

The easy way to turn off automatic updates for Windows 10/11

by: Hystou | last post by:

Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For most users, this new feature is actually very convenient. If you want to control the update process,...

Windows Server

9193

AI Job Threat for Devs

by: agi2029 | last post by:

Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then launch it, all on its own.... Now, this would greatly impact the work of software developers. The idea...

Career Advice

7650

Access Europe - Using VBA to create a class based on a table - Wed 1 May

by: isladogs | last post by:

The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome a new presenter, Adolph Dupré who will be discussing some powerful techniques for using class modules. He will explain when you may want to use classes instead of User Defined Types (UDT). For example, to manage the data in unbound forms. Adolph will...

Microsoft Access / VBA

6879

Couldn’t get equations in html when convert word .docx file to html file in C#.

by: conductexam | last post by:

I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and then checking html paragraph one by one. At the time of converting from word file to html my equations which are in the word document file was convert into image. Globals.ThisAddIn.Application.ActiveDocument.Select();...

C# / C Sharp

5685

Windows Forms - .Net 8.0

by: adsilva | last post by:

A Windows Forms form does not have the event Unload, like VB6. What one acts like?

Visual Basic .NET

3011

Comprehensive Guide to Website Development in Toronto: Expert Insights from BSMN Consultancy

by: bsmnconsultancy | last post by:

In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating effective websites that not only look great but also perform exceptionally well. In this comprehensive...

General