Package Documentation

Open abdulrahman19 opened this issue 5 years ago • 2 comments

Package Documentation

First of all, thanks for all effort in this awesome package.

Can please anyone provides simple & updated documentation for this package, I can't understand many of things, that's will be a great help.

Oct 12 '20 16:10 abdulrahman19

Yes, I agree. The documentation for both the configuration options and how to to interpret the metrics and make them more actionable(How they are measured, and what can you do to improve them) is lacking pretty severely. This limits the value you get from this tool quite a lot.

Oct 22 '20 11:10 pelmered

Until documentation is created, I found this course https://open.hpi.de/courses/softwareanalytics2015 It'll help you to understand many things in this package. Less is better than nothing :smile:

Oct 23 '20 16:10 abdulrahman19