The Wayback Machine - https://web.archive.org/web/20200522003819/https://github.com/donnemartin/gitsome/issues/108
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

Prioritize documentation #108

Open
iamnewton opened this issue Feb 21, 2017 · 2 comments
Open

Prioritize documentation #108

iamnewton opened this issue Feb 21, 2017 · 2 comments

Comments

@iamnewton
Copy link

@iamnewton iamnewton commented Feb 21, 2017

I think the work you've done on this is amazing. Seems like a great project, but your README is a bit bloated and hard to decipher. Might I suggest you condense it down into a set of readable chunks and maybe link off to the wiki for the more detailed bits.

Its only my opinion, but I find that answering the following questions, in order, helps to simplify docs.

  • who? - who wrote the package
  • what? - what is the package? i.e. description of what the package does
  • where? - where the package can be found? i.e. installation via the various package managers
  • when? - current version
  • why? - what makes this package unique, why should i install this
  • how? - how can i help out if i want to

This is just food for thought. I have personally found this README to be quite annoying and difficult to consume.

@donnemartin
Copy link
Owner

@donnemartin donnemartin commented Feb 21, 2017

Hi @chrisopedia, thanks for the feedback!

@ghost
Copy link

@ghost ghost commented Jul 3, 2017

+1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.