Migrate-WindowsUserProfile icon indicating copy to clipboard operation
Migrate-WindowsUserProfile copied to clipboard

Need documentation

Open nickrod518 opened this issue 9 years ago • 5 comments

There needs to be better documentation on how to use this tool including screenshots and explanations of the config section and the GUI.

nickrod518 avatar Feb 12 '17 17:02 nickrod518

Certainly, what medium do you reccomend for the documentation files?

On Sun, Feb 12, 2017 at 9:36 AM, Nick Rodriguez [email protected] wrote:

There needs to be better documentation on how to use this tool including screenshots and explanations of the config section and the GUI.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/nickrod518/Migrate-WindowsUserProfile/issues/11, or mute the thread https://github.com/notifications/unsubscribe-auth/AYaeXO7vyV6oUhirjKNFlZFgX20_M29Mks5rb0MpgaJpZM4L-jdK .

-- William Myers,

Computing Technology Specialist HT Bldg Room 16 Portland Community College Sylvania Campus 12000 SW 49th Ave, Portland, OR 97219 (971)722-6257

WilliamMyers1 avatar Feb 12 '17 23:02 WilliamMyers1

The built in GitHub readme would be ideal because it is robust, allows for images, and is the first thing someone sees when they visit the project. I'll get around to it eventually but if you are ever bored please feel free to jump in!

nickrod518 avatar Feb 12 '17 23:02 nickrod518

Certainly, I'm going to see if I can triangulate this piece with my lead at work as he's much better at generating documentation then myself. We often have to generate documentation for the tools we use at work due to the varied skillsets amongst the other techs.

On Feb 12, 2017 3:56 PM, "Nick Rodriguez" [email protected] wrote:

The built in GitHub readme would be ideal because it is robust, allows for images, and is the first thing someone sees when they visit the project. I'll get around to it eventually but if you are ever bored please feel free to jump in!

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/nickrod518/Migrate-WindowsUserProfile/issues/11#issuecomment-279265177, or mute the thread https://github.com/notifications/unsubscribe-auth/AYaeXFGmOI0SyhOf5K31PTJ4ta2tBP5vks5rb5wjgaJpZM4L-jdK .

WilliamMyers1 avatar Feb 12 '17 23:02 WilliamMyers1

Things to add to documentation:

  • There should be a 'in-progress' screen shot
  • a description of log files created and where they are
    • high-lighting the path to ScanState and ScanProgress.log
  • clearly state where the finished USMT .MIG file will be created by default.

Otherwise, excellent work!

1RedOne avatar Aug 03 '17 14:08 1RedOne

Thanks 1RedOne, I added some info on the log files and mig data file.

P.S. I admire your work with PowerShell, especially Invoke-Clippy!

nickrod518 avatar Sep 08 '17 01:09 nickrod518