EmbeddedRelated.com
Forums

Recomendations for document control software

Started by Anton Erasmus April 30, 2008
Hi,

I think this has been discussed here before, but a search on google
groups did not provide much info. 
I am looking for software to help with document control. I typically
have the following documents for a project.
1. Schematic Source files as well as PDF versions.
2. PCB Source files as well as PDF and Gerber versions
3. Datasheets on all the ICs used. User manuals etc. on more complex
ICs such as MCUs.
4. Design Descriptions, Design Specifications etc.
6. Programming, FPGA source files etc.

I typically keep all my data sheets in a separate directory grouped in
manufacturer directories, and catagories under each manufacturer.
In the past I have kept paper copies of all these things in a file
together with notes etc. This is becomming far to much paper.

I am looking for software, where one can link in all the relevant
documentation, and where one can then easily generate a report giving
the source directory and filename of all documents used. It should
also be possible to generate a directory with all the files copied in
a hierarchy for easy backup to CD or DVD. 

If the software can also be tied in to subversion or other open source
revision control software to provide a complete snapshot of all
documents including source files etc. where a specific revision of a
file is important, then all the better.


I would prefer something which is available on Linux and Windows, and
it must not be based on Access or any other proprietry Microsoft
software.

Any pointers to such software and/or relevant search terms would be
welcome.

Regards
  Anton Erasmus


Anton Erasmus wrote:

>I think this has been discussed here before, but a search on google >groups did not provide much info. >I am looking for software to help with document control. I typically >have the following documents for a project. >1. Schematic Source files as well as PDF versions. >2. PCB Source files as well as PDF and Gerber versions >3. Datasheets on all the ICs used. User manuals etc. on more complex >ICs such as MCUs. >4. Design Descriptions, Design Specifications etc. >6. Programming, FPGA source files etc. > >I typically keep all my data sheets in a separate directory grouped in >manufacturer directories, and catagories under each manufacturer. >In the past I have kept paper copies of all these things in a file >together with notes etc. This is becomming far to much paper. > >I am looking for software, where one can link in all the relevant >documentation, and where one can then easily generate a report giving >the source directory and filename of all documents used. It should >also be possible to generate a directory with all the files copied in >a hierarchy for easy backup to CD or DVD. > >If the software can also be tied in to subversion or other open source >revision control software to provide a complete snapshot of all >documents including source files etc. where a specific revision of a >file is important, then all the better. > > >I would prefer something which is available on Linux and Windows, and >it must not be based on Access or any other proprietry Microsoft >software. > >Any pointers to such software and/or relevant search terms would be >welcome.
Is this the sort of thing ypu are looking for? http://en.wikipedia.org/wiki/Arena_Solutions http://www.arenasolutions.com/products/index.html -- misc.business.product-dev: a Usenet newsgroup about the Business of Product Development. -- Guy Macon <http://www.guymacon.com/>
On Wed, 30 Apr 2008 10:59:56 +0000, Guy Macon
<http://www.guymacon.com/> wrote:

> > > >Anton Erasmus wrote: > >>I think this has been discussed here before, but a search on google >>groups did not provide much info. >>I am looking for software to help with document control. I typically >>have the following documents for a project. >>1. Schematic Source files as well as PDF versions. >>2. PCB Source files as well as PDF and Gerber versions >>3. Datasheets on all the ICs used. User manuals etc. on more complex >>ICs such as MCUs. >>4. Design Descriptions, Design Specifications etc. >>6. Programming, FPGA source files etc. >> >>I typically keep all my data sheets in a separate directory grouped in >>manufacturer directories, and catagories under each manufacturer. >>In the past I have kept paper copies of all these things in a file >>together with notes etc. This is becomming far to much paper. >> >>I am looking for software, where one can link in all the relevant >>documentation, and where one can then easily generate a report giving >>the source directory and filename of all documents used. It should >>also be possible to generate a directory with all the files copied in >>a hierarchy for easy backup to CD or DVD. >> >>If the software can also be tied in to subversion or other open source >>revision control software to provide a complete snapshot of all >>documents including source files etc. where a specific revision of a >>file is important, then all the better. >> >> >>I would prefer something which is available on Linux and Windows, and >>it must not be based on Access or any other proprietry Microsoft >>software. >> >>Any pointers to such software and/or relevant search terms would be >>welcome. > >Is this the sort of thing ypu are looking for? >http://en.wikipedia.org/wiki/Arena_Solutions >http://www.arenasolutions.com/products/index.html
It looks like it might do the job. Unfortunately it also looks like the type of clients they are looking for are fortune 500 sized companies. I am looking for something a little smaller in scope usable by a single person or small team. Regards Anton Erasmus
Anton Erasmus wrote:
> Hi, > > I think this has been discussed here before, but a search on google > groups did not provide much info. > I am looking for software to help with document control. I typically > have the following documents for a project. > 1. Schematic Source files as well as PDF versions. > 2. PCB Source files as well as PDF and Gerber versions > 3. Datasheets on all the ICs used. User manuals etc. on more complex > ICs such as MCUs. > 4. Design Descriptions, Design Specifications etc. > 6. Programming, FPGA source files etc. > > I typically keep all my data sheets in a separate directory grouped in > manufacturer directories, and catagories under each manufacturer. > In the past I have kept paper copies of all these things in a file > together with notes etc. This is becomming far to much paper. > > I am looking for software, where one can link in all the relevant > documentation, and where one can then easily generate a report giving > the source directory and filename of all documents used. It should > also be possible to generate a directory with all the files copied in > a hierarchy for easy backup to CD or DVD. > > If the software can also be tied in to subversion or other open source > revision control software to provide a complete snapshot of all > documents including source files etc. where a specific revision of a > file is important, then all the better. > > > I would prefer something which is available on Linux and Windows, and > it must not be based on Access or any other proprietry Microsoft > software. > > Any pointers to such software and/or relevant search terms would be > welcome. > > Regards > Anton Erasmus
Have you looked at Open Office? I've never used it, but if it duplicates the linking capabilities of MS Word, Excel, etc, then it might do the job. http://www.openoffice.org/
"Anton Erasmus" <nobody@spam.prevent.net> wrote in message 
news:5aag14t0n4b0uur92cdisf6ll8kgs3ia48@4ax.com...
> Hi, > > I think this has been discussed here before, but a search on google > groups did not provide much info. > I am looking for software to help with document control. I typically > have the following documents for a project. > 1. Schematic Source files as well as PDF versions. > 2. PCB Source files as well as PDF and Gerber versions > 3. Datasheets on all the ICs used. User manuals etc. on more complex > ICs such as MCUs. > 4. Design Descriptions, Design Specifications etc. > 6. Programming, FPGA source files etc. > > I typically keep all my data sheets in a separate directory grouped in > manufacturer directories, and catagories under each manufacturer. > In the past I have kept paper copies of all these things in a file > together with notes etc. This is becomming far to much paper. > > I am looking for software, where one can link in all the relevant > documentation, and where one can then easily generate a report giving > the source directory and filename of all documents used. It should > also be possible to generate a directory with all the files copied in > a hierarchy for easy backup to CD or DVD. > > If the software can also be tied in to subversion or other open source > revision control software to provide a complete snapshot of all > documents including source files etc. where a specific revision of a > file is important, then all the better. > > > I would prefer something which is available on Linux and Windows, and > it must not be based on Access or any other proprietry Microsoft > software. > > Any pointers to such software and/or relevant search terms would be > welcome. > > Regards > Anton Erasmus
I haven't used it but Seapine Software's Surround SCM probably meets your needs. I use their TestTrack Pro bug tracker and it is quite good. -- Scott Validated Software Corp.
On Thu, 1 May 2008 08:31:32 -0600, "Not Really Me"
<scott@validatedQWERTYsoftware.XYZZY.com> wrote:

> >"Anton Erasmus" <nobody@spam.prevent.net> wrote in message >news:5aag14t0n4b0uur92cdisf6ll8kgs3ia48@4ax.com... >> Hi, >> >> I think this has been discussed here before, but a search on google >> groups did not provide much info. >> I am looking for software to help with document control. I typically >> have the following documents for a project. >> 1. Schematic Source files as well as PDF versions. >> 2. PCB Source files as well as PDF and Gerber versions >> 3. Datasheets on all the ICs used. User manuals etc. on more complex >> ICs such as MCUs. >> 4. Design Descriptions, Design Specifications etc. >> 6. Programming, FPGA source files etc. >> >> I typically keep all my data sheets in a separate directory grouped in >> manufacturer directories, and catagories under each manufacturer. >> In the past I have kept paper copies of all these things in a file >> together with notes etc. This is becomming far to much paper. >> >> I am looking for software, where one can link in all the relevant >> documentation, and where one can then easily generate a report giving >> the source directory and filename of all documents used. It should >> also be possible to generate a directory with all the files copied in >> a hierarchy for easy backup to CD or DVD. >> >> If the software can also be tied in to subversion or other open source >> revision control software to provide a complete snapshot of all >> documents including source files etc. where a specific revision of a >> file is important, then all the better. >> >> >> I would prefer something which is available on Linux and Windows, and >> it must not be based on Access or any other proprietry Microsoft >> software. >> >> Any pointers to such software and/or relevant search terms would be >> welcome. >> >> Regards >> Anton Erasmus > >I haven't used it but Seapine Software's Surround SCM probably meets your >needs. I use their TestTrack Pro bug tracker and it is quite good.
I am looking for something more than just software development orientated tools. I am already using subversion for software development. I want something where I can add data sheets, notes etc. as I go along. When adding data sheets, it must not duplicate the actual data if I use the same part in a new project which I had already used in a previous project. After a bit more thought and suggestions made by people, I think I need software which helps with the design process and process flow. Something that can tie all the different documents and information together in a structured manner, so that one can find the relevant info at a later date as easily as possible. Regards Anton Erasmus
On May 1, 6:06=A0pm, Anton Erasmus <nob...@spam.prevent.net> wrote:
> On Thu, 1 May 2008 08:31:32 -0600, "Not Really Me" > > > > > > <sc...@validatedQWERTYsoftware.XYZZY.com> wrote: > > >"Anton Erasmus" <nob...@spam.prevent.net> wrote in message > >news:5aag14t0n4b0uur92cdisf6ll8kgs3ia48@4ax.com... > >> Hi, > > >> I think this has been discussed here before, but a search on google > >> groups did not provide much info. > >> I am looking for software to help with document control. I typically > >> have the following documents for a project. > >> 1. Schematic Source files as well as PDF versions. > >> 2. PCB Source files as well as PDF and Gerber versions > >> 3. Datasheets on all the ICs used. User manuals etc. on more complex > >> ICs such as MCUs. > >> 4. Design Descriptions, Design Specifications etc. > >> 6. Programming, FPGA source files etc. > > >> I typically keep all my data sheets in a separate directory grouped in > >> manufacturer directories, and catagories under each manufacturer. > >> In the past I have kept paper copies of all these things in a file > >> together with notes etc. This is becomming far to much paper. > > >> I am looking for software, where one can link in all the relevant > >> documentation, and where one can then easily generate a report giving > >> the source directory and filename of all documents used. It should > >> also be possible to generate a directory with all the files copied in > >> a hierarchy for easy backup to CD or DVD. > > >> If the software can also be tied in to subversion or other open source > >> revision control software to provide a complete snapshot of all > >> documents including source files etc. where a specific revision of a > >> file is important, then all the better. > > >> I would prefer something which is available on Linux and Windows, and > >> it must not be based on Access or any other proprietry Microsoft > >> software. > > >> Any pointers to such software and/or relevant search terms would be > >> welcome. > > >> Regards > >> =A0Anton Erasmus > > >I haven't used it but Seapine Software's Surround SCM probably meets your=
> >needs. =A0I use their TestTrack Pro bug tracker and it is quite good. > > I am looking for something more than just software development > orientated tools. I am already using subversion for software > development. I want something where I can add data sheets, notes etc. > as I go along. When adding data sheets, it must not duplicate the > actual data if I use the same part in a new project which I had > already used in a previous project. > After a bit more thought and suggestions made by people, I think I > need software which helps with the design process and process flow. > Something that can tie all the different documents and information > together in a structured manner, so that one can find the relevant > info at a later date as easily as possible. > > Regards > =A0 Anton Erasmus- Hide quoted text - > > - Show quoted text -
You could look at something like Kompozer to write-up the project in WYSIWYG (almost) HTML with hyperlinks. This can allow almost all the relevant docs to be opened from a browser and it is possible to even link in external sources such as Wikipedia. Another benefit is that it is available 'off' premises if Apache is set up on a server. In conjunction with Subversion (you can use Subversion to maintain the WEB stuff too - which allows easy off-site updating of the website with version control) you the have a system that supports telecommuting. Rocky
Anton Erasmus wrote:

> Hi, > > I think this has been discussed here before, but a search on google > groups did not provide much info. > I am looking for software to help with document control. I typically > have the following documents for a project. > 1. Schematic Source files as well as PDF versions. > 2. PCB Source files as well as PDF and Gerber versions > 3. Datasheets on all the ICs used. User manuals etc. on more complex > ICs such as MCUs. > 4. Design Descriptions, Design Specifications etc. > 6. Programming, FPGA source files etc. > > I typically keep all my data sheets in a separate directory grouped in > manufacturer directories, and catagories under each manufacturer. > In the past I have kept paper copies of all these things in a file > together with notes etc. This is becomming far to much paper. > > I am looking for software, where one can link in all the relevant > documentation, and where one can then easily generate a report giving > the source directory and filename of all documents used. It should > also be possible to generate a directory with all the files copied in > a hierarchy for easy backup to CD or DVD. > > If the software can also be tied in to subversion or other open source > revision control software to provide a complete snapshot of all > documents including source files etc. where a specific revision of a > file is important, then all the better. > > > I would prefer something which is available on Linux and Windows, and > it must not be based on Access or any other proprietry Microsoft > software. > > Any pointers to such software and/or relevant search terms would be > welcome.
An RCS or CVS based set of tools would do all of that. In the commercial offerings see http://www.mks.com/. As for cheaper or free offerings search out Version Control Tools and Change tracking Tools and see who offers both aspects together. Also have a look at <http://filesanywhere.com/?gclid=CNC-oJOIhpMCFQRD1Aod2Gl00w> I've not used it but it looks interesting. -- ******************************************************************** Paul E. Bennett...............<email://Paul_E.Bennett@topmail.co.uk> Forth based HIDECS Consultancy Mob: +44 (0)7811-639972 Tel: +44 (0)1235-811095 Going Forth Safely ..... EBA. www.electric-boat-association.org.uk.. ********************************************************************


Anton Erasmus wrote:
> >Guy Macon <http://www.guymacon.com/> wrote: > >>Is this the sort of thing ypu are looking for? >>http://en.wikipedia.org/wiki/Arena_Solutions >>http://www.arenasolutions.com/products/index.html > >It looks like it might do the job. Unfortunately it also looks like >the type of clients they are looking for are fortune 500 sized >companies. I am looking for something a little smaller in scope >usable by a single person or small team.
I recently set up a six-man engineering dept and a 2-man manufacturing dept overseeing offshore production with it. They set the price very low for small outfits, on the theory that they will stick with Arena a when they become larger. Give them a call and tell them that the Guy Macon who convinced Power Wise in Dallas, Texas to go with Arena sent you. -- Guy Macon <http://www.guymacon.com/>
On Wed, 30 Apr 2008 10:22:40 +0200, Anton Erasmus
<nobody@spam.prevent.net> wrote:

[Snipped]

Answering my own question for other people who might be looking.

I have found the following on sourceforge which looks quite
interesting:
Contineo - Document Management, DMS
http://sourceforge.net/projects/contineo/

It uses a web based interface and can use many of the available open
source databases. 

Regards
  Anton Erasmus