9 Aug
2012
9 Aug
'12
5:39 p.m.
On 08/09/2012 10:38 AM, Jerome Velociter wrote:
On 08/09/2012 04:34 PM, Jeremie BOUSQUET wrote:
I've seen extensions with a lot of documentation on their extension
page, and I've seen things documented in several places. Personally, I
don't like huge extension pages.
So I'd say that:
- There should be some documentation on the extension page, at least a
description of the project, some usage scenarios, some screenshots, and
a list of the features
- I agree that the full documentation should be included in the
application itself
- The same full documentation should also be available online, and the
contrib wiki seems to be the right place (in a dedicated space)
Humm ... Just thinking I might put that directly
inside my app xar ...
WDYT ?
I'm a big fan of self-documenting applications. It has the great
advantage of always offering documentation matching the version in use.
But you might also want to offer the latest released version
documentation online. I think there are some extensions that have
documentation that spans several pages, but honestly I don't know if
this is something we want/we agreed upon. I'll leave it to others to
bring more information on this subject. There is the contrib wiki also
which could be a candidate.
>
> 2012/8/9 Jeremie BOUSQUET <jeremie.bousquet(a)gmail.com>om>:
>> Thanks Jerome,
>>
>> Another thing about this project: I'd like to prepare things, and
>> particularly the user guide part, so it's available when I'll publish
>> the extension.
>> For this particular use-case though, I'd like to extend the user/admin
>> guide part on more than one page, as it may be quite large.
>> Where should I put these pages ?
>>
>> Thanks,
>> Jeremie
--
Sergiu Dumitriu
http://purl.org/net/sergiu/