Forum Discussion
Managing code resources
My team and I use Google Docs because our organisation's standards require the use of Google Apps. We organised a document alphabetically by exercises' names, using tabs and subtabs features and I think that any document organising tool might work :)
Tab 1: Code with explanations -> table of contents with links to subcards through headlines
Subtabs: Specific exercises with illustrations, an introduction about how it works, and each and every line of code explained in detail - what it does, why, what we can change (bold for code, normal text for explanation) - for us to understand what we are doing as non-programmers. (AI helps explain, but we also used resources and our own knowledge, because AI is not always right or specific enough)
Tab 2: Working code -> Table of contents
Subtabs: Each and every exercise in plain code to easily copy and paste by Ctrl+A without additional notes (only useful ones, such as - "//don't forget to change here if..." etc.:D)
Archive: old code, if we need to come back to any version of old code during iterations
We have a test course in Rise in which we test and iterate on exercises. And when we finalise a working exercise, we create a block template in Rise.
Little caveat here: it is quite a lot of work to keep all the documents and block templates up to date - if you change anything in code, you need to change it in two tabs in Google and in the block template. But we have a few people on the team, and we need everyone to have easy access to both the code and the explanations.
Related Content
- 4 months ago
- 8 months ago
- 10 days ago