[FM Discuss] documenting Booktype

Daniel James daniel.james at sourcefabric.org
Thu Apr 19 03:01:08 PDT 2012


Hi Adam,

>> I assume its mainly a user manual? Any need or want for technical
>> sections?
> 
> actually we need tech docs too

Given that it's a short manual at the moment, we could cover
installation and tweaks in the same book. If the book ever becomes too
large, we could split it into separate sysadmin and user guides at that
point. (We had to make that split for the Newscoop manuals).

It's also good to give props to the tools which a product is based on,
which we could do in the introduction. That doesn't seem to happen so
much with cloud providers, which is a shame.

>>> but wait for dans lead...im sure he has some plans for the structure
>>> of the docs ...

I like the structure of the current book at:

http://en.flossmanuals.net/booktype/

I think the Advanced section could do with some expansion, to make it
more like the chapters in the last four sections of the Airtime manual:

http://en.flossmanuals.net/airtime-en-2-0/

Cheers!

Daniel



More information about the Discuss mailing list