← Back to team overview

ooc-dev team mailing list archive

Re: Our documentation system


A lot of hand-written documentation would be in the oocdocs, and it should be 
tightly integrated with the API docs.

As for docs that aren't within the ooc code at all (this would be tutorials 
and guides I assume), they should be right in the same place as the API docs, 
and there should be *easy* linking between hand-written docs and API docs 
(both ways).

I think Factor does this really well, if you want to browse 
http://docs.factorcode.org/content/article-help.home.html for some inspiration 
and ideas.

On Monday 12 July 2010 08:11:38 Friedrich Weber wrote:
> That would cover the API documentation. Then again, what do we do about
> the hand-written documentation?
> Cheers,
> Friedrich