473,382 Members | 1,313 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,382 software developers and data experts.

Documenting Projects - does anyone have any experiance/advice

AAJ
Hi all

I have been set the task of documenting a number of projects that have
developed and grown over the last 5 years. The documentation I collate and
produce for the project, plus links and and other info I find needs to be
manually added to a central repositiory, and made searchable (on both
technical and user guide levels) via our intranet.

The projects involves C#, VB6, SQL Server 2000, MS Access front Ends,
Dreamweaver, IIS etc. Most of the individual code is well documented, but
there is little or no overall documentation relating to how the component
parts sit together, what hardware they run on, any extra details such as
functional summaries etc.

The question I have is - What do you guys use? and have you any
recommendations.

I thought something similar to Google desktop, but more structured towards
a software project.

A typical example might be if the user searched for say 'Project 1 AND
Import', then the engine would look through the relevant project and bring
back say :

A word document containing an exective summary of how importing works for
the specified project.
Other documents that relate to this are of the project.
What language the particular software is written in
where on out servers the source code is stored.
where the executables live
Related visio flow charts
and any other relevant info within the repository that I have added.

I know I could put something together myself, but it would take too long.
I'm looking for an off the shelf document management package that is based
toward provided technical assistance and user manuals rather than checking
documents in/out. What I don't want to write is a static word document that
becomes too large to manage and eventually dies.

thanks in advance

Andy.

Mar 29 '06 #1
0 916

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

1
by: lawrence | last post by:
I'm trying to read up on the rfc's that govern form inputs. Much of what I'm reading is stuff I didn't know before and some of it is alarming. This one left with me questions: ...
2
by: steve deno | last post by:
In 6i, if there was an LOV on an item and the user entered the field, a box with 3 dots popped up. It seems this does not happen in 9i. Does anyone know why? And how to make that happen? ...
2
by: Brent Taylor via AccessMonster.com | last post by:
HELP----DOES ANYONE HAVE A SIMPLE .mdb for MLM structure? Does anyone have an example database for multi-level marketing for a 3 Tier setup? Thank you, brenttaylor@actionimports.net
6
by: Benjamin Day | last post by:
Does anyone ACTUALLY have the application updater block working? I've been beating my head against the wall on this one for about 3 days. It looks cool. It seems promising. I've even read this...
3
by: Mephistopheles | last post by:
>>"Shapper" <mdmoura*NOSPAM*@gmail.*DELETE2SEND*com> wrote in message >>news >>:%23N6vQmpSFHA.3184@TK2MSFTNGP14.phx.gbl... >> Hi, >> I have a function already but I need to solve one...
2
by: Bruno Alexandre | last post by:
Hi guys, does anyone know where is the Website used in the MSDN "Lear ASP.NET 2.0 with Jeff Prosise" (http://msdn.microsoft.com/asp.net/beta2/multimedia/default.aspx) events? The website used...
4
by: neoswf | last post by:
Hey Does anyone knows a powerfull and relaible HTML / JS / CSS Optimization tool ? right now im using stylePro for optimizing CSS and afterwords optimizng it using...
0
by: janithn | last post by:
rss- does anyone know how to embedd rss into my web template for a news site? basically im creating a news website and i want to use RSS to put in articles. Im using MS Frontpage. Does anyone...
19
by: William Gill | last post by:
I seem to be having a mentally bad period lately . My code is beginning to be terrible convoluted mess, and I shudder to think what it will be like to go back in a couple months and try to follow...
0
by: ryjfgjl | last post by:
In our work, we often need to import Excel data into databases (such as MySQL, SQL Server, Oracle) for data analysis and processing. Usually, we use database tools like Navicat or the Excel import...
0
by: Charles Arthur | last post by:
How do i turn on java script on a villaon, callus and itel keypad mobile phone
0
by: aa123db | last post by:
Variable and constants Use var or let for variables and const fror constants. Var foo ='bar'; Let foo ='bar';const baz ='bar'; Functions function $name$ ($parameters$) { } ...
0
by: ryjfgjl | last post by:
If we have dozens or hundreds of excel to import into the database, if we use the excel import function provided by database editors such as navicat, it will be extremely tedious and time-consuming...
0
by: ryjfgjl | last post by:
In our work, we often receive Excel tables with data in the same format. If we want to analyze these data, it can be difficult to analyze them because the data is spread across multiple Excel files...
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
0
BarryA
by: BarryA | last post by:
What are the essential steps and strategies outlined in the Data Structures and Algorithms (DSA) roadmap for aspiring data scientists? How can individuals effectively utilize this roadmap to progress...
1
by: nemocccc | last post by:
hello, everyone, I want to develop a software for my android phone for daily needs, any suggestions?
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.