I have a long history of providing detailed technical documentation both in codebases and directly to clients. Unfortunately, almost all of these cases involve proprietary code or internal discussions, making it quite difficult for me to show off these skills! One easy location to see my documentation style is in my source code for Smashcrowd, a React app that I created to assist my friends in running Super Smash Bros. tournaments.
For examples, I'll direct you to specific files:
- README.md: contains simple instructions in how to run the application.
- smashcrowd-server.js: the script that runs on a server platform, with each function documented and commented.
- smashcrowd-userfactory.js: the server-side script that is used to build User objects.
- smashcrowd-updates.js: the server-side script that updates the database and stored data when version changes are available.
- Board.js: the client-side React script that updates the overall "drafting" board.