in reply to Re: HTML documentation system - design and planning
in thread HTML documentation system - design and planning

I've used wiki, too, as a sort of on-going documentation system for development projects. It rocks! The lack of "ownership" of a node is a really good thing, since anyone can go & update the information on any of the nodes. And the "autolinking" it does is pretty nice- you don't have to worry about marking up words that you want to link, because if wiki sees that anything that you typed is a node, it automagically creates a link for you. Anyway, I've used a lot of different (usually crappy) documentation systems (html docs maintained through cvs... whiteboards in hallways...saved emails...). Most are either too much hassle to update or not scalable enough once you've got more than 3 people on a project. Wiki is a pretty cool solution to problems like that. My one problem with it (which might not be a problem with all versions) is that the more information you put in, the slooooooooooower searches get. -- cat
  • Comment on Re: Re: HTML documentation system - design and planning

Replies are listed 'Best First'.
Re: Re: Re: HTML documentation system - design and planning
by pmas (Hermit) on Sep 09, 2001 at 06:58 UTC
    Thank you for confirming my gut feeling about Wiki.

    Re Slow search: Yes, search on on many static pages might be slow. Solution might be to place all page text into database - DB are usualy good in searching text. Then, you slowered data presentation - because you need to generate every page on request.

    As always, you have tradeoffs. I expect to have a lot of searches, so I prefer my data be optimized for search speed - in database.

    Also, TWIki has "categories", which might speed up searching.

    Our web site should be later released to public, so when it will be up (and open to public), I'll let you know.

    To make errors is human. But to make million errors per second, you need a computer.