Hi, I have a little idea for a module and I'd like to get your input.

When I run a project, be it a single perl module or full scale project with 
tens of modules and lots of documentation (user manual, requirements, 
analysis and design documents, ...) I always have a problem with structuring 
the documents together. The documents themselfs are no problems, only how 
they refere to each other and how to navigate in the structure.

I've used wikis in the passed with various degrees of success depending on the 
setup and size of the project.

Lately, I've been using git much more and I'm trying to have the projects self 
contained. This eliminates wikis that are too often have their own version 
control and keep things in a specific database and needs a server setup.

I have looked at other type of wikis of wich Ikiwiki was close to what I want 
but not really the right thing.

I believe that what is needed is just a way to structure the documents 
together and have a presentation layer. It might be useful to have the 
possibility to modify those documents through a wiki interface but that's not 
my main goal.

My idea is to create set of module to:

- search in the current project documents to be aggregated
- apply a set of filters, eg: transform a DB to a txt file or multiple files 
in a single file
- create the aggregation structure
- render the structure in a specific format, HTML, PDF, ...

If you have used the excellent 
http://search.cpan.org/~lyokato/Pod-ProjectDocs-0.36/bin/pod2projdocs, I want 
to do the same thing but on any document that might be relevant.

Some of the documents will be written in wiki description language and I plan 
to support multiple languages (through the filters).

What do you think about this idea?
Is there already something out there?
Would you like to join this project?
What would you like to see in it?

Cheers, Nadim.








Reply via email to