Re: Cool Idea: Wiki as Documentor



except ur re-inventing the wheel.


<larry@xxxxxxxxxxxxxxxxx> wrote in message
news:1130433656.875940.226920@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
| This idea came to me yesterday as I was working on a Web based DB for
| work:
|
| Instead of having the documentation be a hard coded page, use a wiki to
| manage it, then you can update on the fly as necessary - which would
| also work great for prototyping the documentation or implementation of
| a more flexible on-line documentation system.
|
| Here I've been using eWiki to do some Wikipages for work, it uses just
| a single page reference with some GET data for which page to pull up.
| (i.e. ewiki.php?id=FontPage) In my php app I can make my category
| headings (or whatever I need documentation for to point to a wiki with
|
| (a href="ewiki.php?id=NewClientRecord" target="_blank")How to Add a
| Client Record(/a)
|
| If the wiki page doesnt exist, ewiki puts me into an editor, if it does
| it displays the page. This also gives the end-user a chance to write
| the docmentation right (fixing my spelling errors, etc.) or to adjust
| it over time due to updated policies and procedures.
|
| Larry
|
| Link:
| Ekiki - http://erfurtwiki.sourceforge.net/
|


.



Relevant Pages

  • Re: documentation for novice and newbies
    ... That was a problem in the documentation. ... something like "For Novices and Newbies to Debian". ... Under this we could have individual wiki entries that we could work on. ... To the extent we use GPL, ...
    (Debian-User)
  • Re: -Crawl- -Stone Soup- Release Announcement (yes, Release Announcemen
    ... one person doing the documentation or that online thing. ... person") without using a wiki. ... but will mention any contributers in the credits (every ...
    (rec.games.roguelike.misc)
  • Re: Angband documentation project
    ... referring to off-line documentation. ... The documentation is mostly likely to be referred to immediately after ... This makes sense - however the Wiki edit history is probably easier to determine ... PDF, HTML etc. ...
    (rec.games.roguelike.angband)
  • Re: Angband documentation project
    ... Given that my plans involve making the help external HTML files (with ... Using a wiki isn't that great for this, ... the documentation is currently distributed as, ... helpfiles are probably GPL, though that's not really that appropriate ...
    (rec.games.roguelike.angband)
  • Re: User comments on python.org
    ... >> comments be included inline as an SSI? ... documentation has problems, the domain is inherently confusing or large ... (perhaps linking to other Wiki pages that go on at length on a topic). ... I think it will be better when the comments are included inline, ...
    (comp.lang.python)