The design team is keen to give our Human Interface Guidelines a refresh: they haven’t been updated in a while, and are outdated. The guidelines would also benefit from some realignment, to cover topics that haven’t been addressed so far, and maybe drop some sections which aren’t so useful.
If we’re refreshing the HIG, we’d also like to change how the HIG is written and published. The existing HIG is built using GNOME’s standard developer documentation infrastructure: it’s written in Mallard, is part of
gnome-devel-docs, and is published online using
library-web. Sadly, the result is that it’s hard to maintain, doesn’t look great, and isn’t very easy to navigate.
We need a HIG that is easier to maintain and develop. We also need an attractive website for it, which is easy to navigate. Obviously, we’d prefer to achieve these goals using the standard GNOME docs infrastructure, and to tightly integrate with the rest of the developer documentation. However, given the current state of affairs, the design team is inclined to develop our own website to host the new version of the HIG.
We’d be interested in discussing which web technologies to use, out of the box documentation hosting solutions, and how to integrate with the rest of the developer documentation. Or, if this kick starts a renewed effort to improve GNOME’s documentation infrastructure, then we’d be interested in that too.