The best kind of documentation let's you try your own code, right there
#1
Programming Reference: feature to try your own code next to code snippets
Reply
#2
(02-11-2023, 06:58 PM)CharlieJV Wrote: Programming Reference: feature to try your own code next to code snippets

In case it is of any interest.

I'm in the process of rejigging the navigation for my programming reference.

Here's a rough first draft of notes describing this feature (i.e. running sample code and trying your own code while reading about some concept/feature/whatever):

Demonstration Programs and Runs
Reply
#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




Users browsing this thread: 3 Guest(s)