This module will give you a quick and easy introduction to software documentation: what it is, why it's important, and how you can do it.
It is designed to be completed as a self-guided online module in parallel to your course work, to help you become better software programmers in the future!
The module is divided into 5 parts. The typical breakdown of each part is as follows (not every part has these components):
- An overview of the learning goals, so you know what to expect (<1 minute)
- A video to introduce major concepts related to software documentation (~10 minutes)
- A short, ungraded quiz to help you assess your understanding of ideas (~5 minutes)
- An optional activity where you can apply the concepts you have learned to create good documentation (~10 minutes)
Module Content
- Part 1: Intro to Software Documentation
- Part 2: Approaches to Documentation
- Part 3: The ACCEU Framework
- Part 4: README Files
- Part 5: Conclusion & Afterword