Connecting Tech Pros Worldwide Help | Site Map

Wiki software suggestions for an extensive project?

 
LinkBack Thread Tools Search this Thread
  #1  
Old January 28th, 2006, 03:25 AM
news@celticbear.com
Guest
 
Posts: n/a
Default Wiki software suggestions for an extensive project?

I've been working someplace for a year now where a previous employee
spent 4 years writing hundreds of pages and tens of thousands (perhaps
hundreds of thousands) of lines of code in PHP.
And I and a newer employee have pounded our heads on various functions
and pages and includes... and it just occured to me to start making a
wiki for the site!
As we work on pages and components we can add to the wiki and be able
to search and find tips and tricks that were before commited only to
memory or scratch paper.

So, any suggestions on a good wiki software?
Preferably using a mySQL database.
I've found MediaWiki and WakoWiki and they seem like good
possibilities.

Suggestions?
Thanks!
-Liam


  #2  
Old January 28th, 2006, 06:05 AM
John Bokma
Guest
 
Posts: n/a
Default Re: Wiki software suggestions for an extensive project?

news@celticbear.com wrote:
[color=blue]
> I've been working someplace for a year now where a previous employee
> spent 4 years writing hundreds of pages and tens of thousands (perhaps
> hundreds of thousands) of lines of code in PHP.[/color]

How well documented is the PHP. It might be quite rewarding to have a tool
that is able to extract the comments out of it, and make documentation
automatically. (aka javadoc) I am sure that those tools are available.

<http://www.google.com/search?q=javadoc%20for%20php>
[color=blue]
> And I and a newer employee have pounded our heads on various functions
> and pages and includes... and it just occured to me to start making a
> wiki for the site![/color]

I would start with extending the documentation of the PHP stuff, and
transforming it into something that can be used with the aforementioned
tool. Also the good old plain paper for drawing relations between things
might be a good idea.

(I have some experience, once I was asked to maintain 650+ modules of
Perl)
[color=blue]
> As we work on pages and components we can add to the wiki and be able
> to search and find tips and tricks that were before commited only to
> memory or scratch paper.[/color]

The major advantage of documenting the source and autogenerating the
documentation is that you have the documentation in one place: the source.
If you run the aforementioned tool. And the amazing this is: it's a wiki.
You edit the pages in your editor by loading the source :-D

And of course you use something like subversion for version control.

--
John Experienced (web) developer: http://castleamber.com/
Perl SEO tools: http://johnbokma.com/perl/
NEW ----> Textpad reference card (pdf): http://johnbokma.com/textpad/

  #3  
Old January 28th, 2006, 06:45 AM
Steve
Guest
 
Posts: n/a
Default Re: Wiki software suggestions for an extensive project?

On Fri, 27 Jan 2006 20:11:45 -0800, news wrote:
[color=blue]
> I've been working someplace for a year now where a previous employee
> spent 4 years writing hundreds of pages and tens of thousands (perhaps
> hundreds of thousands) of lines of code in PHP.
> And I and a newer employee have pounded our heads on various functions
> and pages and includes... and it just occured to me to start making a
> wiki for the site!
> As we work on pages and components we can add to the wiki and be able
> to search and find tips and tricks that were before commited only to
> memory or scratch paper.
>
> So, any suggestions on a good wiki software?
> Preferably using a mySQL database.
> I've found MediaWiki and WakoWiki and they seem like good
> possibilities.
>
> Suggestions?
> Thanks!
> -Liam[/color]

I use mediawiki, and am happy with it. However, if it's going to end up in
the public domain, then my recommendation is that you forget it! I am *so
sick* of cleaning up and closing down yet more avenues. You end up with so
much security on it that you might as well have used static html.

Internally, obviously it's a different matter, and I stand by my
suggestion (:

Steve

  #4  
Old January 28th, 2006, 10:35 AM
Karl Groves
Guest
 
Posts: n/a
Default Re: Wiki software suggestions for an extensive project?

news@celticbear.com wrote in news:1138421505.300483.278160
@g44g2000cwa.googlegroups.com:
[color=blue]
> I've been working someplace for a year now where a previous employee
> spent 4 years writing hundreds of pages and tens of thousands (perhaps
> hundreds of thousands) of lines of code in PHP.
> And I and a newer employee have pounded our heads on various functions
> and pages and includes... and it just occured to me to start making a
> wiki for the site!
> As we work on pages and components we can add to the wiki and be able
> to search and find tips and tricks that were before commited only to
> memory or scratch paper.
>
> So, any suggestions on a good wiki software?
> Preferably using a mySQL database.
> I've found MediaWiki and WakoWiki and they seem like good
> possibilities.
>[/color]

Why not try this instead?
http://www.phpdoc.org/


--
Karl Groves
http://karlcore.com
http://chevelle.karlcore.com
  #5  
Old January 28th, 2006, 05:15 PM
Gunther Herzog
Guest
 
Posts: n/a
Default Re: Wiki software suggestions for an extensive project?

I like WikkaWiki. Color syntax highlighting for PHP and a few other
dozen languages as well, at least some of which might be related to your
project, for instance HTML, CSS, JavaScript and ActionScript (for the
client-side stuff). Even better (and the reason why I choose this one)
is that it supports the FreeMind mind mapping software; I start off all
projects with a Mind Map. If you'd like to play around with the
interface, feel free to stop by...

http://www.gunthersoft.com/collaborate/

Some other tools I would not do without are (1) unit testing, and (2)
inline documentation. More links:

http://www.gunthersoft.com/links/simpletest
http://www.gunthersoft.com/links/phpdocumentor

Hope this helps,
GH


news@celticbear.com wrote:[color=blue]
> I've been working someplace for a year now where a previous employee
> spent 4 years writing hundreds of pages and tens of thousands (perhaps
> hundreds of thousands) of lines of code in PHP.
> And I and a newer employee have pounded our heads on various functions
> and pages and includes... and it just occured to me to start making a
> wiki for the site!
> As we work on pages and components we can add to the wiki and be able
> to search and find tips and tricks that were before commited only to
> memory or scratch paper.
>
> So, any suggestions on a good wiki software?
> Preferably using a mySQL database.
> I've found MediaWiki and WakoWiki and they seem like good
> possibilities.
>
> Suggestions?
> Thanks!
> -Liam
>[/color]
 

Bookmarks

Thread Tools Search this Thread
Search this Thread:

Advanced Search

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is Off
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are On

Popular Articles

What is Bytes?

We are a network of experts and professionals in IT and software development that help one another with answers to tough questions and share insights. Get the best answers to your questions from over 220,989 network members.