Am 08.09.2016 um 08:44 schrieb Matthias Urlichs:
> On 08.09.2016 08:29, Johan Ström wrote:
>> Regardless of which one we find most
>> suiting, I'd say we should keep all info in *one* place
> Personally I'd rather use Sphinx or similar. The main reason is that
> it's reasonably easy to sustain a coherent narrative structure, i.e. one
> could convert the whole thing to a single PDF for off-line perusal (or
> even (inclusion in) a book).
>
This is all very nice, very sleek, still someone has to persuade me to
write the documentation with this tool. Because I bet, in the long run,
no one else does. (No offense, anyone of the developers could have said
that.)
We need more collaborators for the documentation. A sleek output is
good, because people even value technical documentation by its looks.
But more important is a low barrier to contribute.
> Also, you can store the API documentation within the code, so there's a
> chance it'll actually stay up to date.
>
It came to me as experience my lifetime would never suffice to fix all
the things I know clever solutions for. So I usually stick to fix things
that are really a problem right now.
API documentation is off-track. We are talking about user documentation,
aren't we?
Kind regards
Jan
------------------------------------------------------------------------------
_______________________________________________
Owfs-developers mailing list
Owfs-developers@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/owfs-developers
