The best kind of documentation let's you try your own code, right there
#3
Documentation that not only shows sample code, right there, that you can run and a place for you to try your own code ...

Documentation that dynamically generates keyword lookup links from the sample code.

So you are reading a topic, see sample code, and lookup the keywords in that sample code.

That's the beauty of having the documentation not as static content, but as a single-page web application that generates documentation on-the-fly when/where needed.

Prototype setup for the Demonstration Programs and Runs documentation page.  (The "KWL" button opens the Keywords and Symbols Lookup window)

   

   
Reply


Messages In This Thread
RE: The best kind of documentation let's you try your own code, right there - by CharlieJV - 03-25-2023, 06:07 PM



Users browsing this thread: 4 Guest(s)