msstyleEditor icon indicating copy to clipboard operation
msstyleEditor copied to clipboard

Create proper documentation and tutorials

Open nptr opened this issue 3 years ago • 0 comments

Over the years the tool has gained a small user base and help requests keep coming in. It's not a lot, but I still think it is time for some documentation and tutorials to help new or infrequent users. This issue shall serve the purpose of tracking and organizing the progress.

I am aiming for a web based documentation, probably hosted used github pages or using the wiki functionality. For structure, I'd go with a location map kind of style. Each chapter shows a screenshot of an important object with all the known parts highlighted. I suppose a rough overview is enough for the intelligent user to find its way and figure out a solution to the specific problem.

Chapter Subchapter Status
Introduction hardly any
Basic Concepts Visual Styles okay
Common Controls okay
Window Frames basic
Explorer basic
Desktop todo

When time allows, I'll add more information and examples how I imagine the documentation. To contribute, please

  • create a comment here
  • attach a screenshot of the object in question
  • highlight and numerate its parts
  • provide the "paths" in msstyleEditor like Button > CHECKBOX > UNCHECKEDDISABLE > TEXTCOLOR

I'll collect and polish the provided snippets.

Update: Find the basics here: https://github.com/nptr/msstyleEditor/wiki/Introduction It's still very basic, but better then nothing.

nptr avatar May 14 '21 20:05 nptr