diff options
Diffstat (limited to 'docs/docs.md')
| -rw-r--r-- | docs/docs.md | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/docs/docs.md b/docs/docs.md index ed6ec85e..aa8a4d48 100644 --- a/docs/docs.md +++ b/docs/docs.md @@ -1,9 +1,9 @@ -# Restructure afl++'s documentation +# Restructure AFL++'s documentation ## About us We are dedicated to everything around fuzzing, our main and most well known -contribution is the fuzzer `afl++` which is part of all major Unix +contribution is the fuzzer `AFL++` which is part of all major Unix distributions (e.g. Debian, Arch, FreeBSD, etc.) and is deployed on Google's oss-fuzz and clusterfuzz. It is rated the top fuzzer on Google's fuzzbench. @@ -11,27 +11,27 @@ We are four individuals from Europe supported by a large community. All our tools are open source. -## About the afl++ fuzzer project +## About the AFL++ fuzzer project -afl++ inherited it's documentation from the original Google afl project. +AFL++ inherited it's documentation from the original Google AFL project. Since then it has been massively improved - feature and performance wise - and although the documenation has likewise been continued it has grown out of proportion. The documentation is done by non-natives to the English language, plus none of us has a writer background. -We see questions on afl++ usage on mailing lists (e.g. afl-users), discord +We see questions on AFL++ usage on mailing lists (e.g. afl-users), discord channels, web forums and as issues in our repository. -This only increases as afl++ has been on the top of Google's fuzzbench +This only increases as AFL++ has been on the top of Google's fuzzbench statistics (which measures the performance of fuzzers) and is now being integrated in Google's oss-fuzz and clusterfuzz - and is in many Unix packaging repositories, e.g. Debian, FreeBSD, etc. -afl++ now has 44 (!) documentation files with 13k total lines of content. +AFL++ now has 44 (!) documentation files with 13k total lines of content. This is way too much. -Hence afl++ needs a complete overhaul of it's documentation, both on a +Hence AFL++ needs a complete overhaul of it's documentation, both on a organisation/structural level as well as the content. Overall the following actions have to be performed: @@ -44,9 +44,9 @@ Overall the following actions have to be performed: * The documents have been written and modified by a lot of different people, most of them non-native English speaker. Hence an overall review where parts should be rewritten has to be performed and then the rewrite done. - * Create a cheat-sheet for a very short best-setup build and run of afl++ + * Create a cheat-sheet for a very short best-setup build and run of AFL++ * Pictures explain more than 1000 words. We need at least 4 images that - explain the workflow with afl++: + explain the workflow with AFL++: - the build workflow - the fuzzing workflow - the fuzzing campaign management workflow @@ -65,8 +65,8 @@ us. ## Metrics -afl++ is a the highest performant fuzzer publicly available - but is also the -most feature rich and complex. With the publicity of afl++' success and +AFL++ is a the highest performant fuzzer publicly available - but is also the +most feature rich and complex. With the publicity of AFL++' success and deployment in Google projects internally and externally and availability as a package on most Linux distributions we see more and more issues being created and help requests on our Discord channel that would not be @@ -75,7 +75,7 @@ is unrealistic. We expect the the new documenation after this project to be cleaner, easier accessible and lighter to digest by our users, resulting in much less -help requests. On the other hand the amount of users using afl++ should +help requests. On the other hand the amount of users using AFL++ should increase as well as it will be more accessible which would also increase questions again - but overall resulting in a reduction of help requests. @@ -103,7 +103,7 @@ graphics (but again - this is basically just guessing). Technical Writer 10000$ Volunteer stipends 0$ (waved) T-Shirts for the top 10 contributors and helpers to this documentation project: - 10 afl++ logo t-shirts 20$ each 200$ + 10 AFL++ logo t-shirts 20$ each 200$ 10 shipping cost of t-shirts 10$ each 100$ Total: 10.300$ @@ -118,5 +118,5 @@ We have no experience with a technical writer, but we will support that person with video calls, chats, emails and messaging, provide all necessary information and write technical contents that is required for the success of this project. It is clear to us that a technical writer knows how to write, but cannot know -the technical details in a complex tooling like in afl++. This guidance, input, +the technical details in a complex tooling like in AFL++. This guidance, input, etc. has to come from us. |