Slashdot Mirror


Document Management and Version Control?

Tom wonders: "I am working in a medium-sized software development company. The functional analysts use Microsoft Word to document the specifications, and Sharepoint to publish the documents. However we'd like to improve our process to have better revision control and traceability. We have looked at alternatives like using Wikis, or static HTML documents with CVS. The functional analysts want ease of use, while we developers would like to see high-quality end products, revision control (i.e. tagging & branching of the document base), and traceability features. What tools and document formats do you use and would recommend?"

10 of 326 comments (clear)

  1. The simple answer by Ckwop · · Score: 5, Informative

    Latex with CVS. This is what I use for my documents. It's simple (yes it is simple.. markup languages are not hard to understand) and with CVS it's far more feature complete than Word in version control.

    There's plenty of WYSIWYG tools for Latex. Let Google be your guide.

    Simon.

    1. Re:The simple answer by CRCulver · · Score: 5, Informative

      There's plenty of WYSIWYG tools for Latex.

      I'm always happy to see fellow TeX evangelists here. If you don't know about LaTeX yet, check out the TeX Frequently Asked Questions and discover the joys of a typesetting system that is not only high-quality, but free as in freedom and immensely extendable.

      LaTeX's markup makes so much sense that a WYSIWYG tool isn't necessary, for even the man on the street can be just a productive with doing it up in a text editor. A good and free as in beer guide to the system is The Not So Short Introduction to LaTeX2e , though if you are going to be markup up lots of math (LaTeX's specialty) you'll probably want Graetzer's Math Into LaTeX since LShort doesn't cover it so much.

    2. Re:The simple answer by Ithika · · Score: 4, Informative

      LaTex may be terminally cool for creating fancy-looking documents. But it doesn't solve any problems that this guy cares about. For his purposes, it's just another word processing format.

      Not true. The OP asks about version control and branching... and the best way to store something for version control is as plain text. Yes, modern version control software allows fairly sophisticated binary deltas (for example, I believe SVN has this capability) but there are still features that can't be done without text.

      For example, can your version control software tell you what text changed between two revisions of Word documents? It can if they're LaTeX documents.

    3. Re:The simple answer by flooey · · Score: 4, Informative

      LaTex may be terminally cool for creating fancy-looking documents. But it doesn't solve any problems that this guy cares about. For his purposes, it's just another word processing format.

      Actually, switching to LaTeX changes the scope of the problem from tracking changes to arbitrary files to tracking changes to text files. There are a lot more tools that are good for the latter problem than the former, so the available options get bigger. You're right that it doesn't suggest a good tool to go with, though.

  2. Subversion... by nweaver · · Score: 4, Informative

    Subversion is your friend...

    It handles binaries right (unlike CVS)

    It works over a variety of transport layers (HTTP/HTTPS/SSH) with some decent authentication models.

    It treast revisions as an archive-wide property.

    You can't check in an inconsistant state.

    It runs under *NIX, Mac, Windows, etc.

    Its free software.

    Try it. I switched a few months back from CVS and have been very happy.

    --
    Test your net with Netalyzr
    1. Re:Subversion... by dpaton.net · · Score: 4, Informative

      After several years of working with SourceSafe and it's truly braindead way of dealing with atomic commits and binary files (not to mention the massive data loss problems we had with it) my office switched to SVN for EVRYTHING. All employees use it for everything, from notes on ideas in Notepad or BBEdit or pico, to massive software projects with hundreds of files and over a million lines of code. Using TortiseSVN to put it into the windows desktop shell, it's nearly transparent, and it allows atomic commits to work intelligently, making the engineers who work with programs that have multiple files (hardware in myb case, a half dozen files for each PCB design, it works even better for revision control for the software guys), which has allowed us to recover a really insane amount of time we'd been handing over to M$SS for maintainance and babysitting. Additionally, the (automagically compressed) repository size for 11 hardware guys and 13 software guys with a year's worth of code and binaries (2M lines and hundreds of MBs, local, respectiively) is a paltry 180MB. That's with upwards of 20 commits on everyone's data every day. I admit, I sound like I drank the SVN kool-aid, and I'm OK with that. The next step is to install it at home and use it to back up /home, /documents and /music on my various and sundry computers (seperate server, weekly media swap, etc).

      I love it that much, and you can too!

      --
      This is not a sig. this is a duck. quack.
  3. Meta-answer by Jerf · · Score: 4, Informative

    I doubt I'll have much to add to the long list of people describing their experiences with various systems, but I'll pop out this meta-thought: Your developers and "functional analysts" probably have wildly varying needs, especially if the "functional analysts" use word-processing documents like Word. There's no crime in given each group of people a separate system.

    Your devs probably ought to get subversion because the continuing cost of using a sub-optimal source management system adds up to staggering amounts pretty fast. Your other writers probably aren't continuously branching and merging and doing all the other things subversion allows (if nothing else that's really confusing for most documents), so they can use a simpler, easier-to-use system that doesn't incur continuous costs due to confusion and documents getting mangled or destroyed due to incorrect use of the system.

    The right tool for the right job.

    (Note: I'm not saying you should use multiple systems; I'm just saying it's not a crime, if they solve different problems. If you can get your writers to use SVN, especially if they use something with a decent plaintext representation that stands a chance in Hell of merging, hey, great, more power to you.)

  4. SVN + WebDAV + Autoversioning by HFShadow · · Score: 5, Informative

    http://svnbook.red-bean.com/nightly/en/svn.webdav. autoversioning.html

    From the SVN Handbook:
    "Because so many operating systems already have integrated WebDAV clients, the use case for this feature borders on fantastical: imagine an office of ordinary users running Microsoft Windows or Mac OS. Each user "mounts" the Subversion repository, which appears to be an ordinary network folder. They use the shared folder as they always do: open files, edit them, save them. Meanwhile, the server is automatically versioning everything. Any administrator (or knowledgeable user) can still use a Subversion client to search history and retrieve older versions of data."

  5. Re:Subversion...[*Does* Call Binary Diff Tools] by malloc · · Score: 5, Informative

    Of course, Subversion is no more your friend than CVS in this case since neither can do proper diffs! It's binary data for f*ck sake! Subversion handles binaries better than CVS, but not for the reason you state.

    Actually, GUI Subversion clients like TortoiseSVN can show diffs for binary files like Word or OpenOffice, using the built-in diff capability of these programs. The end result is you can double-click your binary document and get a window showing you the differences.

    The latest nightly TortoiseSVN builds even include an image diff viewer.

    -Malloc
    --
    ___________________ I want to be free()!
  6. Word has this built in by boatboy · · Score: 4, Informative

    Alot of people don't realize it, but there is document versioning built into Word. If it's turned on, it will track changes, etc. by user. There is also pretty rich editing capabilities. Reviewers can mark up the doc with comments, etc... Adding sharepoint lets you distribute that process pretty well. Get an in-depth Word book and figure out how to do it in sharepoint/word.