forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Sean Wheller <s...@inwords.co.za>
Subject Re: User docuementation (was Re: Selective PDF - Who uses Forrest?)
Date Mon, 15 Nov 2004 18:15:08 GMT
On Monday 15 November 2004 18:28, Ross Gardler wrote:
> The
>
> > information architecture I would suggest is:
> >
> > Description - tell them what it is, concepts and block diagram of the
> > thing. Preparation - tell them what they need and how to do it.
> > Installation - tell them how to install and test.
> > Deployment - tell them how to deploy projects in various environments.
> > Customization - tell them how to develop and customize it.
> >
> >
> > Rough and very high level, but let's start with that and see other
> > peoples ideas.
>
> One thing is for sure, our documentation is not ideal (maybe even of no
> use) for the non-technical end user. It has been said before, and will
> be said again, *any* documentation contribution will be very gratefully
> accepted. In recent weeks we have seen a number of How-To's and
> documentation patches contributed by new arrivals, this is great to see
> and I hope that this flow continues.
>
> What we are still lacking is some core documents that bring it all
> together, your outline above looks great to me, like you said "let's
> start".

Ross I will knock together some outlines for people to start working with.

-- 
Sean Wheller
Technical Author
sean@inwords.co.za
http://www.inwords.co.za

Mime
View raw message