Documentation and FAQ for custom ABE rules

Discussions about the Application Boundaries Enforcer (ABE) module
Phil

Documentation and FAQ for custom ABE rules

Post by Phil » Sat Nov 14, 2015 3:21 am

Regarding the FAQ entry at https://noscript.net/faq#qa8_10 and the main user documentation page at https://noscript.net/abe/users.html

It's easy to reach the latter when looking for documentation on writing custom ABE rules, and not not see the very useful information in the FAQ.

I suggest that the content in that FAQ entry be moved into the users.html page, and that the FAQ entry simply links to it. That way the information is maintained in one place (the most useful place for it, I believe), but is accessible from both.
Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:42.0) Gecko/20100101 Firefox/42.0

Phil

Re: Documentation and FAQ for custom ABE rules

Post by Phil » Sat Nov 14, 2015 3:25 am

(Double-negative "not not" was a typo, of course.)
Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:42.0) Gecko/20100101 Firefox/42.0

barbaz
Senior Member
Posts: 9140
Joined: Sat Aug 03, 2013 5:45 pm

Re: Documentation and FAQ for custom ABE rules

Post by barbaz » Sat Nov 14, 2015 6:04 pm

-1. People don't want to have to click links to get answers to FAQ.

The reverse might be an interesting idea though (linking the FAQ from the ABE for users page).
*Always* check the changelogs BEFORE updating that important software!
-

Phil

Re: Documentation and FAQ for custom ABE rules

Post by Phil » Sun Nov 15, 2015 3:22 am

FWIW my reason for suggesting that it be the other way around was that I suspect people are much more likely to visit https://noscript.net/abe/users.html in search of answers to ABE questions. When you use the ABE UI in NoScript, the question mark link takes you directly to https://noscript.net/abe/ and right at the top of the page is the link to "ABE for NoScript Users", so my guess is that very few people will go hunting for a FAQ page *before* having already read through the https://noscript.net/abe/ pages, so why not have the documentation in the place they'll look first?

Either way is good, though -- so long as those pages do link to one another, users will find their way to the information they need, which is the important thing.
Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:42.0) Gecko/20100101 Firefox/42.0

Post Reply