On 5/28/13, Joachim Dreimann <[email protected]> wrote:
> I would like to challenge the assumption that we need to ship the
> help/guide wiki pages with Bloodhound by default.
>
> I believe our users and us are better served by adding local documentation
> as an optional plug-in.
>
> In any default installation of Bloodhound there should be only a single
> "What you need to know" page of documentation, short enough to be printed
> out on a single A4 sheet of paper.
>
> The recent conversations on where documentation should live were the
> trigger to me thinking about this [1]. From a community perspective this
> change would bring more people back to our site, which must be a good
> thing. From a user perspective they're guaranteed to get the latest
> documentation for their version. For example when better documentation on
> 0.5 is available after the release of 0.5, they wouldn't find this in their
> locally installed version.
>
There are only two remarks I'd like to mention :
1. some users might be offline
2. we'll need some sort of versioning scheme in the wiki.
my point is that following that approach , if user is running
x.y and latest version is x.y+1 then docs for that particular
version should be expected ... isn't it ?
> It also encourages us to keep documentation up to date because it has a
> more direct impact on the community, and we can gather some insights on
> what people struggle with by analysing what information they look up
> frequently. I could go into more about "one version of the truth" and
> "online repository of versioned documentation"
... I'm hoping this will come some day ... ;)
> but I hope the benefits are
> clear enough already.
>
yes I agree ; just take my previous comment as a hint.
;)
[...]
--
Regards,
Olemis.
