• Status: Solved
  • Priority: Medium
  • Security: Public
  • Views: 1079
  • Last Modified:

Documentation Software

Hello,

I am looking for some really easy to install and use documentation software for the web using PHP. I want to add help docs to an application, but would like to be able to just add simple titles and content and have it indexed automatically for our users. I have checked out Sourceforge and Hotscripts without much luck.

Has anyone had experience with documentation / knowledge base software?

I would ideally prefer links to software you have actually used and recommend, since I have searched around plenty and found nothing that jumps out at me.

Many thanks,

Bodog.
0
cracky
Asked:
cracky
  • 4
  • 2
  • 2
  • +4
2 Solutions
 
UmeshMySQL Principle Technical Support EngineerCommented:
0
 
crackyAuthor Commented:
Thanks uhastry, but I am looking for end user help documentation, not coding documentation. Both phpdoc and PHPDocumentor are used for programmers to parse PHP comments as class / method descriptions etc. The documentation I require is for end users.
0
 
armoghanCommented:
I think the problem is not related to PHP directly
Why dont you try HTMLhelp from microsoft to create static Help pages
and attach it with Php application
0
Introducing Cloud Class® training courses

Tech changes fast. You can learn faster. That’s why we’re bringing professional training courses to Experts Exchange. With a subscription, you can access all the Cloud Class® courses to expand your education, prep for certifications, and get top-notch instructions.

 
crackyAuthor Commented:
armoghan > I think the problem is not related to PHP directly

In fact, it is.

I am looking for a PHP documentation feature / software that I can use to create help docs or a knowledge base with a minimum of effort. I want to be able to add / edit / remove help topics dynamically without having to export a static set of pages. Besides, I have successfully worked the last year without touching a single Microsoft product and I intend to keep it that way. It's like junk food, once you wean yourself off it, you don't even feel like it anymore.
0
 
armoghanCommented:
you can use a content management system for this purpose
0
 
hernst42Commented:
Have you looked at http://www.hotscripts.com/PHP/Scripts_and_Programs/FAQ_and_Knowledgebase/index.html There are a lot of scripts in PHP listed one might b able to do what you want.
0
 
techtonikCommented:
If you know how to write in DocBook, you can use PHP documentation build system. =)
In short:
 - your documentation sources are in XML format (DocBook elements and rules);
 - you can validate your document for structure errors;
 - you use templates to convert XML into something readable (i.e. HTML or text);
 - templates are in XSL language;
 - templates can be common DocBook templates or your custom modified DocBook.

Learning curve:
 - learn about XML;
 - learn about DTD (Document Type Definition) - standard for particular XML content;
 - understand validation toolchain: XML + DTD = error log
 - understand transformations toolchain: XML + XSL = HTML or whatever..
 - (optional) understand XSL language.
 - read some tutorial on DocBook to really put it together =)
   http://www.google.com/search?q=docbook+tutorial&sourceid=opera&num=0&ie=utf-8&oe=utf-8
   http://wiki.docbook.org/topic/DocBookTutorials

Drawbacks:
 - DocBook is rather big standard, though it isn't complex.

You can fetch example from PHP CVS:
http://cvs.php.net/livedocs/
Page of interest:
http://wiki.phpdoc.info/LiveDocs
0
 
crackyAuthor Commented:
I have read a little about DocBook and forgot about it entirely. Looks like a good solution for a scalable help system. Exactly what I need.

Thanks also to hernst for finding me some scripts I missed.

techtonik, could you possibly show me some examples of DocBook documentation systems with a more graphical representation? Of course, since it uses XSLT, presenting DocBook in a prettier way isn't hard. I couldn't see anyone presenting in anything but the most basic HTML. It would be great if you could point me to some well-presented documentation examples.

Cheers.
0
 
techtonikCommented:
All PHP documentation is rendered from DocBook sources (with some minor tweaks), but unfortunately with DSSSL (non-XSL) template toolchain. FreeBSD handbook is also an example of DSSSL output http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/.

As for XSL examples - you can look at xCHM edition, which has been made with XSL. http://cvs.php.net/phpdoc/htmlhelp. The reason why DSSSL is used instead of XSL is mostly of historical reasons. XSL tools for a long time were not enough polished to produce usable output, so during this time there were a lot of tweaks made to DSSSL templates. So one have to do a lot with XSL to make output the same. Needless to say, that many just followed "If it ain't broke, don't fix it" principle.

So, there are not too much ready to use examples, because XSL toolchain is rather young, but not because it is very hard to customise DocBook. Starting point here is DocBook XSL stylesheets and basic HTML is a base function of them. After you've generated your first HTML files - you can customise DocBook templates, insert CSS styles and other stuff in output. Good resource about customising is here: (http://www.dpawson.co.uk/docbook/styling/custom.html) and, of course, http://wiki.docbook.org/topic/DocBookXslStylesheets.

Hope you are not dissapointed. =)  XSL is the future of DocBook and is actively developed. The recent version of XSL DocBook templates released just some days ago and is available on http://sourceforge.net/projects/docbook/
0
 
crackyAuthor Commented:
Thanks techtonik. Exactly what I wanted.

Cheers.
0
 
AJAY CHADHACommented:
Have you had a look at PHPKB knowledgebase software from http://www.knowledgebase-script.com
0
 
Adwait ChitaleyCommented:
Hello,

We use mediawiki for our documentation. We have installed mediawiki with FCKEditor extension for easier input (WYSIWYG) and used the Page Names to link up the Help Page with the context form.

Through this, we get a good Collaborative Document Maintenance Platform and also, a linked Help Documentation.
0
 
AJAY CHADHACommented:
PHPKB uses InnovaEditor which makes the WYSIWYG editing compatible on all browsers such as Google Chrome, Safari, Internet Explorer, Firefox etc. plus it is backed by 12 months of free private technical support.
0
Question has a verified solution.

Are you are experiencing a similar issue? Get a personalized answer when you ask a related question.

Have a better answer? Share it in a comment.

Join & Write a Comment

Featured Post

Cloud Class® Course: Amazon Web Services - Basic

Are you thinking about creating an Amazon Web Services account for your business? Not sure where to start? In this course you’ll get an overview of the history of AWS and take a tour of their user interface.

  • 4
  • 2
  • 2
  • +4
Tackle projects and never again get stuck behind a technical roadblock.
Join Now