[GNC-dev] Register Documentation Improvements (was Re: [GNC] Column widths again)

[Geert Janssens]

Op dinsdag 21 augustus 2018 20:50:38 CEST schreef Geert Janssens:
> Op dinsdag 21 augustus 2018 17:49:57 CEST schreef Adrien Monteleone:
> > but is there a list of ’needs’ of the
> > developers to use when evaluating methods?
> 
> I don't think it's ever been formally written down. But here is a first
> list:
> 
> - it should be as easy as possible to use by non-technical people
> - it should allow multiple output formats. A few the come to mind:
> html, pdf, epub, mobi, windows compressed help, xml for yelp,...
> - it should support both on-screen output as printable output. This is
> mostly relevant for image resolutions.
> - it should support the usual typical documentation constructs, like
> chapters, sections, subsections, indexes, links, tables, images,...
> - it should be manageable. That is there should be mechanisms to support
> multiple versions of one document simultaneously. A typical use case is that
> some feature gets documented that is in both the current version and the
> future one, so this document snippet should be in both versions of the
> documentation as well. While a snippet that's only for the newer version
> should only be in the future version of the documentation. And after a few
> months it should still be obvious which snippets have been integrated in
> which versions.
> - I would like to see a WYSIWYM ("what you see is what you mean") kind of
> editor for the documentation process.
> 
> This is non-exhaustive and I expect the other developers may have even more
> requirements.
> 
Add a way to relatively easily manage translations of the documentation.

Regards,

Geert