How to do documentation
What is the right form of documentation?
I've finished up the website over the past few days and I'm not sure how in depth I should make the documentation or if written documentation is the best method for showing how stewy works.
In the past when I started out by following other peoples projects, super in depth technical documentation was quite overwhelming. I'm not quite sure how in depth I should go or really what the best format is. Personally, I've learned best by following long form videos where I write the code and build the robot as the instructor does it.
For now, I think I'll stick with the high level descriptions of each file in the documentation page, then run a poll after stewy's release for what form future documentation should come in. Do people want technical written documentation, Written guides, video guides, Short form, long form? I think the right choice is getting stewy out there and asking for your opinion.
Hi James,
I agree with you, long form video helps to follow along. Wriitten documentation in my view is also important as reference - it is difficult to go back and search for a specific detail in a long video. A good example of how both can work together is the Articulated Robotics series of video tutorials and companion blog posts by Josh Newans (https://articulatedrobotics.xyz/). Anyway, I looked at your site and have to congratulate you on the quality of the documentation you have already there.