how to document existing web application
Moderator: General Moderators
- raghavan20
- DevNet Resident
- Posts: 1451
- Joined: Sat Jun 11, 2005 6:57 am
- Location: London, UK
- Contact:
how to document existing web application
hello, i would like to know how to document an existing web application so that it can be used by new people to read, understand and work with the web application. i would like to know which sections should be covered such as, api-level documentation, uml, general purpose/functionality of app, config files, controllers, models, templates, etc. Are there any good tutorials around that can explain the things to cover while developing documentation for developers? Do you also recommend using any specific tools for the purpose?
Thanks, Rag.
Thanks, Rag.
- RobertGonzalez
- Site Administrator
- Posts: 14293
- Joined: Tue Sep 09, 2003 6:04 pm
- Location: Fremont, CA, USA
-
alex.barylski
- DevNet Evangelist
- Posts: 6267
- Joined: Tue Dec 21, 2004 5:00 pm
- Location: Winnipeg
- raghavan20
- DevNet Resident
- Posts: 1451
- Joined: Sat Jun 11, 2005 6:57 am
- Location: London, UK
- Contact:
thanks for your comments.
how many of you use wiki to document application? is there any particular approach while documenting using wiki? is it possible to include php formatted code in wiki just like how we display php code in forums?
when it comes to web, which are the main technical things do you think one should document?
how many of you use wiki to document application? is there any particular approach while documenting using wiki? is it possible to include php formatted code in wiki just like how we display php code in forums?
when it comes to web, which are the main technical things do you think one should document?
- Chris Corbyn
- Breakbeat Nuttzer
- Posts: 13098
- Joined: Wed Mar 24, 2004 7:57 am
- Location: Melbourne, Australia
I use a wiki. API documentation is nice and all that so I include it, but you don't get the same level of guidance with an API as you do with a wiki. It really depends what wiki you use as to what the featureset will be but I doubt you'll find a wiki that doesn't at least supportraghavan20 wrote:thanks for your comments.
how many of you use wiki to document application? is there any particular approach while documenting using wiki? is it possible to include php formatted code in wiki just like how we display php code in forums?
when it comes to web, which are the main technical things do you think one should document?
Code: Select all
<?php code_here() ?>GoogleCode's wiki system uses your subversion repository which I think is quite cool. I thought about writing a subversion-backed wiki myself once.
- raghavan20
- DevNet Resident
- Posts: 1451
- Joined: Sat Jun 11, 2005 6:57 am
- Location: London, UK
- Contact:
hello chris, thanks for your reply. i have now started using dokuwiki based on your recommendation. i think it would take me a day or two to familiarize with important features. i was trying moinmoin wiki, but it needed pythong and i dont really know how to use python in apache.
luckily dokuwiki is in php to my rescue
this does also have some kind of repository to store file versions. i have not personally used CVS or Subversion and I think this wiki is kewl.
- seodevhead
- Forum Regular
- Posts: 705
- Joined: Sat Oct 08, 2005 8:18 pm
- Location: Windermere, FL
I have been looking for a general php/mysql wiki software to use to document my web applications. I notice dokuwiki uses flat files... which is a bit of a drag... I move my stuff around so much and have some permission stuff going on... I'd rather use MySQL.
Anyone know of a good php/mysql wiki? From the research that I've done.. it seems that MediaWiki ( http://www.mediawiki.org/wiki/MediaWiki ) is the leader... no?
Anyone know of a good php/mysql wiki? From the research that I've done.. it seems that MediaWiki ( http://www.mediawiki.org/wiki/MediaWiki ) is the leader... no?
- RobertGonzalez
- Site Administrator
- Posts: 14293
- Joined: Tue Sep 09, 2003 6:04 pm
- Location: Fremont, CA, USA
http://www.wikimatrix.org/ is a cool little resource to start searching at.
Another one is http://en.wikipedia.org/wiki/Comparison ... i_software, which lists several features of the software pack in a nice easy to read table.
Another one is http://en.wikipedia.org/wiki/Comparison ... i_software, which lists several features of the software pack in a nice easy to read table.
- raghavan20
- DevNet Resident
- Posts: 1451
- Joined: Sat Jun 11, 2005 6:57 am
- Location: London, UK
- Contact:
wikimatrix is a good site; i should have got this earlier. no problem, i may use a different wiki to document another project.Everah wrote:http://www.wikimatrix.org/ is a cool little resource to start searching at.
Another one is http://en.wikipedia.org/wiki/Comparison ... i_software, which lists several features of the software pack in a nice easy to read table.
for chris: i could not really find plugins to change the view of the dokuwiki. you got any links for it?
Thanks to all.
- seodevhead
- Forum Regular
- Posts: 705
- Joined: Sat Oct 08, 2005 8:18 pm
- Location: Windermere, FL
- RobertGonzalez
- Site Administrator
- Posts: 14293
- Joined: Tue Sep 09, 2003 6:04 pm
- Location: Fremont, CA, USA