[FM Discuss] Help, Advice, Tips for a project documentation.

[RedMight Muntek]

Howdy!

 

I have been a heavy user of a FLOSS (GPL v2) project for several years now,
but only recently have I become more involved. I have been pushing heavily
for more "open-nes" and my efforts have paid off in the creation of "teams"
to lead separate areas of development/support.

 

Say hello to the new Documentation Team Leader :)

 

Unfortunately I'm definitely not a writer nor a documentation expert. I have
used some FLOSS Manuals from you guys before, and have thought them to be
most excellent so I come here looking for help and advice. 

 

Currently the project has a hodge-podge of varying quality documentation
spread across a wiki, a forum, and an issue tracker. I'm looking for
suggestions and best practices on how I should go about reorganizing,
restructuring, and creating all the current and needed stuff into a cohesive
set of useful and consistent documentation.

 

The Project is Redmine - http://redmine.org . We just had a meeting of team
leaders ( http://www.redmine.org/projects/redmine/wiki/Teams ) and have
agreed to have Book sprint in July. Prior to that still need to get things
prepared, and some semblance of organization created. I'm looking to split
the docs into three areas - For Developers, For Administrators, and For
users.

 

Any help, advice, tips, or suggestions anyone is willing to give would be
much appreciated!

 

Thanks!

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.flossmanuals.net/pipermail/discuss-flossmanuals.net/attachments/20100514/bb44faab/attachment.htm>