erlide_eclipse
erlide_eclipse copied to clipboard
erlang
Wiki improvement
When reading the wiki, there are lots of clicking around to various wiki pages, this makes it hard looking for something you know is there, but you can't remember which page it is on. It would be easier to find things if there was one large page with all user documentation.
Here is a good motivation from the POSS book [*].
"For online documentation, make sure that there is a link that brings up the entire documentation in one HTML page (put a note like "monolithic" or "all-in-one" or "single large page" next to the link, so people know that it might take a while to load). This is useful because people often want to search for a specific word or phrase across the entire documentation. Generally, they already know what they're looking for; they just can't remember what section it's in. For such people, nothing is more frustrating than encountering one HTML page for the table of contents, then a different page for the introduction, then a different page for installation instructions, etc. When the pages are broken up like that, their browser's search function is useless. The separate-page style is useful for those who already know what section they need, or who want to read the entire documentation from front to back in sequence. But this is not necessarily the most common way documentation is accessed. Often, someone who is basically familiar with the software is coming back to search for a specific word or phrase, and to fail to provide them with a single, searchable document would only make their lives harder."
source: http://producingoss.com/en/producingoss.html#documentation-availability
[*] http://producingoss.com A book that describes "How to Run a Successful Free Software Project"
Yes, but having separate pages has its advantages too... I suppose I could have a script that merges together all the wiki pages. I am also planning to create the Eclipse help contents from the same wiki pages, so these could be done at the same time.
