1
edit
Changes
→Comments on the Documentation (By Mike Lau)
'''Comments on The README.txt File
* The README.txt file is hard to read in notepad. There's vertical scrolling I after opening the file.
* The file should have output samples to show the user what output to expect and to ensure they are on the right track.
* The pre-requisites part of the READE README file is missing minimum size to be allocated in the computer to complete the install.
* Following the procedures for installation was difficult. The document should number the procedures and have sample outputs to ensure the user is going on the right track
* Some of the folders which was listed in the Directory Structure was missing in the setup procedures. The Directory Structure should be used as a guilde guide to ensure users have the right folders in place. Also, there should be an image to represent the directory structure. Some of the folders which needed to be created on top of following the procedures provided were: base_profile, extension_perf_testing, extension_perf_reports
* The Setup part was hard to follow. Most of the steps were not intuitive.
* Step 4 of the procedures was unclear. I was not sure what kind of YAML config file to be created. The document should tell the user expcity what the file name needs to be called as or tell the user they can call it however they wish. It should also show an example filename as well.