Developers have several reasons not to document their code. Sometimes it is a lack of time, a lack of perceived value, etc. In order to make it easier for developers to create documentation, we decided to create a few templates for them.
Obviously, code can be changed in different ways. Sometimes, it is simply modifying the name of a variable. Other times, it might be a refactor that changes a significant ratio of structure of the code base. Hence, we decided not to create one template for all situations, but different templates for different scenarios.
Following are the templates that users can use.
The new page should be included inside the software section. So far, there's no documentation for the components inside proc_image_processing. However, we suggest to add the future documentations inside a new subcategory that can be called "Features".
View template
The documentation created when refactoring the code can be added to the Software -> Architecture section.
View template
The documentation created when fixing an error can be added to the Software -> Corrections section. This section does not exist yet, but can be created in the main page of the SONIA Wiki documentation page.
View template