Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs:add phishing scenario page #959

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs:add phishing scenario page #959

wants to merge 1 commit into from

Conversation

blackHatMonkey
Copy link
Member

Add a page describing all the available scenarios along with screen shoots.

Add a page describing all the available scenarios along with screen shoots.
@sophron
Copy link
Member

sophron commented Jul 4, 2018

Brian,

A documentation is not about repeating the same information that a user can get from when running the tool. Our docs should describe our top-down design with detail.

Specifically, regarding our phishing scenarios, we don't want to provide a brief description of the scenarios (something that a user can find by running the script). First, we want to provide answers to questions:

  • "Why should I use this scenario? In which cases does it make sense to run it?"
  • "How can I make this phishing scenario even more realistic from a user perspective?"

And after that, we can deep to the technical aspects and answer questions such:

  • "How does it work?"
  • "How can I hack it / make it better if I'm a coder myself?"

@blackHatMonkey
Copy link
Member Author

@sophron

A documentation is not about repeating the same information that a user can get from when running the tool

I'm confused. By this logic we shouldn't include the arguments in the README file either because the user can get it by running the --help option right? 😕

Specifically, regarding our phishing scenarios, we don't want to provide a brief description of the scenarios (something that a user can find by running the script)

Let's assume that some users are willing to spend time running all options and configurations but not all will. People are lazy myself included and want to use the least amount of time figuring something out.
Furthermore documentation helps new users the most because these are the people who have either never used it or have very little experience. Another class of people who I think you are missing is the people who are just evaluating the tool. They want to know if it is the right tool for their case and good documentation can help with this.

Do I think that this PR is the perfect documentation for the phishing-pages of course not but it is a good start. We can build on top of it to include more information like you mentioned about use cases and more. Any valid (not deprecated) documentation is better than nothing 😄 .

@minanagehsalalma
Copy link

@sophron i do agree with @blackHatMonkey this shows to the users that didn't use the tool what it's capable of doing ... and testing all the modes to see what it lookes like would take too much time and that would case to some modes/options to be never known or used .. not in case if the they was able to see more description about it in the readme or anywhere else other than testing it !

@Mikewins1
Copy link

I agree. It would be a great page to have.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants