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

[Chepi Gimenez]

Hi everyone!

First post here...

As a communicator, I'd advise you to stick to that split-up plan. Defining
specific audiences to target is definitely the soundest first step.

Then you should probably split the app in task-related logical blocks,
following the path each user group has to follow to complete tasks in the
app. Have some volunteer noobs test the app -as users, devs or admins- and
write down every inconsistency or question. You probably have a lot of these
info in your forum, but sistematizing it according to the logical blocks I
mentioned should also help any current or future UX team.

And those blocks and their corresponding taskpaths are your chapters and
subchapters. By now you should have sections and titles consistently
structured. Add content -and images!- and you're on.

Iterate. Often.

Hope it helps!

Cheers,


chepi



On Fri, May 14, 2010 at 11:21 AM, RedMight Muntek <Muntek at redmight.com>wrote:

>  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!
>
> _______________________________________________
> Discuss mailing list
> Discuss at lists.flossmanuals.net
> http://lists.flossmanuals.net/listinfo.cgi/discuss-flossmanuals.net
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.flossmanuals.net/pipermail/discuss-flossmanuals.net/attachments/20100514/d86f04c2/attachment.htm>