Saulo Vallory's Mind

After sometime developing the Neobase framework and trying to ease the process of learning how it works, I noticed how difficult it is to provide a really good documentation. Perhaps, this is why it is so difficult to find such thing in the majority of open source softwares. This though never stopped bugging me and I kept thinking: there needs to be an easier way to do that!

Despite the look I get from almost every software developer I asked about the matter, six months ago I started researching the process of software documentation. I’m specially interested in frameworks documentation, because documenting a software gets far more difficult when the software is a framework. My goal is to specify a platform which will, hopefully, make documenting software easy, or, at least, less painful. I named this platform SoftDoc.

I’m writing a paper about my findings, and how the proposed SoftDoc platform would address the documentation process issues. For now, there is only a draft (in portuguese). I will translate it and upload the english version as soon as possible.