Documentation usability degradation

It seems most people like the new documentation style. I do not. I actually use the documentation on a daily basis, so I am less impressed with look-and-feel and most sensitive to any degradation in actual usability.

Today I discovered that the navigation menu no longer includes applications! How is this an improvement?

At the top of the top page you can select the version from a drop down and quickly see what has changed between versions. Prior to 27 the navigation menu was organized in an Application Groups section, then that header was removed but the grouping remained. Now we have to navigate to Module Index, locate a module of the application and select the link in the third column (which is unnecessarily truncated).

This is plain obfuscation. Why would we be hiding the concept of applications? My suggestion would be an Applications section, if you want to simplify the top level navigation menu.

One of my complaints about the new style, beginning in 27, is how the modules within an application are organized. This used to be a flat list, ordered alphabetically, but is now grouped by concept(?). This impedes me because to find a module I now have to guess what group it may be in. For example to find lists in stdlib I need to know it’s a datatype and not a data structure.

Similarly in erts the functions of the erlang module are grouped by other concepts, causing me to stop and think about where to find it.

Now I realize that the root problem here is that while I actually read the documentation, few people do anymore. I do not however accept that that truism reflects on the importance of the documentation.

11 Likes

Calm down :slight_smile:

It is a bug in the latest patch, nothing intentional, hopefully fixed in the next patch.

7 Likes

Not only do I fully agree with Vance regarding the structure of the documentation, but the new layout has certainly not improved as far as I’m concerned. For me as a visually impaired person, the documentation is a lot less useful. The documentation may now look more similar to the average layout of other software, but as far as I’m concerned, it hasn’t improved.

4 Likes

I miss getting PDFs for the documentation. In the old version there was a link which returned the PDF. If one still exists today then it has been hidden.

I also find the module concept grouping very irritating. As @vances pointed out you need to know what “group” it is a member of. Same with the functions in a module listing.

8 Likes

Yes! I feel uncomfortable about these concepts, too! I miss the old simple documents, where I can easily find what I need without extra thinking.

Erlang kept simple for 40 years, why can’t its document keep simple?

3 Likes

Agreed, that’s been bugging me ever since they introduced the new docs. Taking erlang — erts v16.1.2 as an example, the functions are inside groups, making it really awkward to find the function I’m looking for. I’d much prefer a simple, flat, alpha-numerically sorted list of all functions in that module.