View Issue Details
|ID||Project||Category||View Status||Date Submitted||Last Update|
|0005814||unreal||documentation||public||2021-02-06 08:09||2021-02-06 08:09|
|Summary||0005814: Rewrite parts of help.conf|
|Description||A while ago I started translating help.conf to Dutch. That translation was unused but it did give me a "fresh look" at HELPOP, seeing things from the end-user perspective.|
I think various things can be simplified, and less assumptions about prior knowledge should be made (common mistake), more cross-references, etc.
Also balance the "readability" vs "technically correct" thing that was pointed out here https://github.com/unrealircd/unrealircd/pull/117.
Mentioning all these exceptions makes it harder to read, which is an issue especially for parts of documentation (such as HELPOP) which is read by end-users (and not only admins of IRC servers).
There could be a middle ground there, with a general statement about bypassing stuff, or tagging items with [*]
Anyway, this is just a side-issue of this bigger item.
|Tags||No tags attached.|
|3rd party modules|