Best Approach To Provide Technical Documentation

Dec 21, 2010

I landed on a job to continue working on exisiting asp.net 3.5 application using Visual Studio 2008. The former .net developer is no longer around and I have to dig into the application code to understand how the app works( workflow, logic, etc...)I have added new development to the existing application and enhanced existing pages. Now, I need to provide Technical documentation for the application so any new developer comes onboard will not struggle enhancing the app or do new development following the same methodology . Q1. What is the best approach to provide technical documentation.I thought of the following

View 1 Replies


Similar Messages:

Prepare Functionality And Technical Documentation

Oct 4, 2010

I ve completed a web application and now i want to prepare functionality and technical documentation for the same. But i ve never done such documentations. Can someone provide how to prepare such documentations.

View 2 Replies

How To Write Technical Specifications Document

Mar 15, 2011

i am new this preparing a technical specifation document explain me how write a techical specification document.

View 4 Replies

C# - Technical Difference Between .Net Desktop And Web Applications?

Aug 26, 2010

I have just started learning C#. Can anyone explain the technical differences between a .Net desktop application and a web application? I mean for example, if I have a simple HelloWorld application using a WinForm, what are the steps required to change that into a HelloWorld web application?

View 5 Replies

Web Applications / Technical Limitations With Deploying Webserver?

Aug 30, 2010

I'll soon be managing a fleet of ASP.NET webservers...

What are the technical limitations with deploying an ASP.NET webserver? Can I just copy the file(s) over, restart the website, and I'm good to go?

Is this any different than what VS2010's "deploy" does?

Does it matter what "type" of project I have: a Web Site or a Web Application?

View 2 Replies

Security :: Technical/performance Limit On The Number Of Roles An Application Handles?

May 31, 2010

Is there a technical/performance limit on the number of roles an application handles? I'm in the process of designing an application which I forsee having a lot of roles created, to be able to handle the degree of granularity the system should have (e.g., permissions per project, where there could be a lot of projects).

Would you recommend another approach other than using roles for this kind of granularity?

View 1 Replies

Detailed Technical Information On The Compilation Process For Aspx Pages And Vs2008?

Jul 24, 2010

I'm looking for detailed technical information on the compilation process for aspx pages and vs2008.Recently I have been learning about controlbuilders and pageparserfilters. I have downloaded some code to clean out extra white spaces in my html in order to make the pages smaller. The code works great, but I don't understand WHY it works. I need to learn more about the page compilation process.

View 1 Replies

C# Online Documentation Generator

Apr 15, 2010

We are developing a very complex eCommerce portal using asp.net c# and the client asked us to make the documentation very similar (look & feel) with ebay api documentation http://developer.ebay.com/DevZone/shopping/docs/CallRef/GetSingleItem.htmlhat kind of tool they are using and if not do you know anything that can be configured to produce a similar result ?

View 1 Replies

Razor Reference Documentation

Jan 23, 2011

Now that ASP.NET MVC 3 with the new Razor engine has been officially released, is there any official documentation for it?The question asp.net mvc3 razor documentation? has some good links to introductory texts. But I'm looking for a reference documentation that contains a complete description of all @keywords.

View 2 Replies

How To PrepareTechnical Documentation Template

Mar 24, 2011

I am developing Asp.Net C# project. I need to prepare documentation for that. Which include Architectural Design,Database and Class diagrams for our project. I searched many sites but I didnt find any perfect template for it. i want to find nice template for the documentation.

View 2 Replies

AJAX :: Documentation For AnimationExtender?

May 19, 2010

I'm looking to find more information about the AJAX AnimationExtender - I get the impression that it is a quite powerful framework, but there is only 1 very simple example on the AJAX pages, and a server-side coding reference. I would like to know where I can get a more detailed explanation of using the AnimationExtender, that might cover more comprehensively all the XML options that are available, and how to carry out Javascript routines - does anybody know where this sort of resource might be found. Presumably they do want us to use the controls to their maximum, but the documentation I have been able to find so far seems quite inadequate. For example, I would like to know how to pause an AE animation, but I cannot find a single example anywhere!

View 3 Replies

Writtting Documentation To .NET Applications?

Jul 8, 2010

I am new to .NET Programming language. I am working on developing couple of applications using VS2005.My company is a startup company and I am the only developer, so we don't have any standard documentation formats/templates.But I need to use few documentation templates like I need to write functional documentation and technical documentation.Is there any specific template provided by Microsoft or

View 4 Replies

C# - Documentation On Tags Instead Of Using TABLE's?

Feb 28, 2010

I've just come across these in MVC, and would like to use them instead of tables sometimes,as tables and DIV's just don't mix well!Never seen these before,and was wondering if there is any documentation about these new table-substitute TAGs? I've also heard recommendations to use these as opposed to tables and would therefore like to familiarize myself with them properly (as opposed guessing how they work as I have been recently).

View 2 Replies

MVC :: What Is The Best Approach To One To Many Relationships

Aug 5, 2010

What is the best approach to one to many relationships?

This is my scenario:

I have a simple one to many relation:

Customer
CustomerID
Name
tel
CustomerNotes
Id
Note
customerID

I want to have a DETAIL view of customers and CREATE view for CustomerNotes all in the same page.

I create CustomerController and the different views and its respective actions for edit, create, delete, etc.

I also create a CustomerNotesController and the views and actions like before, but I made the views PARTIALS

I put a RENDERPARTIAL for the CustomerNotes create view in the Details view from Customer.

When I run the app, the page is render as expected: It shows the detail info of the customer and bellow the create form for the notes. However, when I click SAVE, nothing happens. I put a breakpoint in the notes controller and never get hit.

I also try with RenderAction and don't work at all.

View 4 Replies

DDD Approach Be Used With NHibernate?

Nov 12, 2010

I've been reading up on DDD a little bit, and I am confused how this would fit in when using an ORM like NHibernate. Right now I have a .NET MVC application with fairly "fat" controllers, and I'm trying to figure out how best to fix that. Moving this business logic into the model layer would be the best way to do this, but I am unsure how one would do that.

My application is set up so that NHibernate's session is managed by an HttpModule (gets session / transaction out of my way), which is used by repositories that return the entity objects (Think S#arp arch... turns out a really duplicated a lot of their functionality in this). These repositories are used by DataServices, which right now are just wrappers around the Repositories (one-to-one mapping between them, e.g. UserDataService takes a UserRepository, or actually a Repository). These DataServices right now only ensure that data annotations decorating the entity classes are checked when saving / updating.

In this way, my entities are really just data objects, but do not contain any real logic. While I could put some things in the entity classes (e.g. an "Approve" method), when that action needs to do something like sending an e-mail, or touching other non-related objects, or, for instance, checking to see if there are any users that have the same e-mail before approving, etc., then the entity would need access to other repositories, etc. Injecting these with an IoC wouldn't work with NHibernate, so you'd have to use a factory pattern I'm assuming to get these. I don't see how you would mock those in tests though......................

View 3 Replies

How To Add A File To A VS2010 Project For Documentation

Jan 5, 2011

I would like to include a word document, and unused program files in a folder as part of my project, but I don't want it compiled, etc. How is the best way to do this?

View 1 Replies

How To Find Documentation On The Accordion Control

Oct 29, 2010

Been trying to find documentation on the accordion control. Was wondering if it's possible to have all the Accordion Panes collapsed when the web page loads?

View 5 Replies

How To Make And Analyse Database Documentation

Sep 15, 2010

the format of how to make and analyse database documentation.

View 1 Replies

Where To Find Documentation Or Tutorials On MVC2

Mar 31, 2010

It looks like the final release for ASP.NET MVC 2 has been already around for 2 weeks. Unfortunately, I can't find documentation that's intended for MVC 2 exclusively. I've checked Amazon.com (no book yet on MVC2), ScottGu's Blog (only 2 short posts), ASP.NET/MVC website (they've only posted what are alreadi in the ScottGu's blog).

View 4 Replies

Sipmle Cms For Internet Shop With Documentation?

Mar 27, 2010

free sipmle cms for internet shop with documentation? i downloaded nopcommerce but there no free documentation

View 2 Replies

Version 4 Documentation / Trying To Find The Local Help For It?

Feb 21, 2011

I've just installed ASP.NET version 4.0 and I'm trying to find the local help for it.

(IOW: Accessing help with Document Explorer).

OS is Win XP (updated).

Looking in: Start > All Programs

I do not see an entry for Microsoft .NET Framework SDK v4.0

I do see the old entry for Microsoft .NET Framework SDK v2.0

I've always accessed local help with the following shortcut:

"C:Program FilesCommon FilesMicrosoft SharedHelp 8dexplore.exe" /helpcol ms-help://MS.NETFramework.v20.en /LaunchNamedUrlTopic DefaultPage /usehelpsettings NETFrameworkSDK.20

How do I get this to work for version 4.0?

... or ...

Did something go wrong with the install?

View 2 Replies

Best API Reference / Similar To The Java Documentation?

Sep 8, 2010

One thing I've always appreciated about Java is the straightforward API documentation. Since Oracle took over Sun, it is a little less intuitive to get to, but basically, you go to:

http://download.oracle.com/javase/6/docs/api/

and you are set. Click on your class in the left area (example: String) and boom, you can read a brief overview of the class, see the various constructors, review the methods and return types, parameters, etc. These days I'm 100% C# and .NET but I often have trouble finding a good class API reference similar to that which I'm used to in Java (as I'm a former Java developer). So I thought I'd ask the community which references you all use and if there is something similar to the Java documentation.

View 4 Replies

Documentation For Globalization And Localization Of Awebsite In Vb.net?

Apr 18, 2010

can you recommend some documentation for Globalization and localization of awebsite in asp.net and vb.net

View 7 Replies

Visual Studio :: XML Documentation In VWD Express?

Jul 12, 2010

I am needing to produce some technical documentation for a web app I have been developing. I have been using XML commenting with a view to using sandcastle to create my documents. The problem is that I can't see how it works with express as there are no XML document settings in the build options.

Can sandcastle be used with express and if not does anyone know of any (free) tools that I can use to automatically create my documentation?

View 5 Replies

SQL Server :: In Xp_send Mail Is There A Documentation?

Sep 1, 2010

i need to send a mail from sql server i need some documentation because i do not know how to do?

View 2 Replies







Copyrights 2005-15 www.BigResource.com, All rights reserved