Skip to content

Documentation Ruminations

Chuck Jungmann edited this page Jan 13, 2025 · 1 revision

This project is a tool for presenting collections of information in flexible ways. The objective is that the tool would make it easy for users to create custom personal tools that haven't been provided by the community.

In the interest of making an effective introduction to the software, I am experimenting with different forms of instructional documentation. I usually expect to see tutorials that have code fragments scattered among prose explaining the development platform. What I am trying is to have a complete working script with prose scattered among the code. That should enable a reviewer to experiment with code by making incremental changes for learning purposes.

I am looking for feedback about whether my efforts are worthwhile. I think there are two main objectives: does it sufficiently communicate the burden of developing a new application with the tool? And does it provide enough information for a new user to successfully create a new app?

Clone this wiki locally