Welcome Guest, Not a member yet? Register   Sign In
What do you use to create your documentation?
#1

[eluser]kilishan[/eluser]
Is the standard hand-written docs, or phpDoc, or something else?

I would love to see a 'standard' format come around so that people could easily ship help with their classes that can be integrated into a single 'ebook'.

For example, here's what I picture:

- I download a new class/library/module/etc and put their included help into a subdirectory within my docs/user_manual/whatever folder.
- When I point my browser to http://mysite.local/docs it pulls up an automatically generated TOC for the main help files that are included, ie one for each class/library/etc. All of the help can be browsed from one central location.

I haven't seen anything like this, but was considering putting together some simple code to make it happen, but wanted to see what the 'standards' were out there and if anyone else was interested in a project like this before I did. It might just be something that I put together for my own libraries and see where it goes from there. Smile




Theme © iAndrew 2016 - Forum software by © MyBB