Documentation

document of your code is vital thing in development. its helps you in several ways.
- helps to have a better understanding about the code you write.
- easily shows someone that what have you done.
- help you to write cleaner code
i have been search for example documentation that have been done related to app development but i only finds apple WWDC 23 sample apps documentation.
actually there is no template for the documentation because it get vary from the type of the application or framework that you are writing.
following template is made by me for my personal use.
this is heavily inspired by the documentation style of apple and their sample app documentation.

references : https://developer.apple.com/documentation/swiftui/backyard-birds-sample

Overview

giving the brief introduction about the how the app is behaving and what are the features of the app. this can be done by using either point form or paragraph style.
in here also mention what type architecture you are using in the app.

list down if there is any specific requirements or framework to install for up and running the app.

explain the code behind the critical UI's . (this applicable if you are using a special approach for creating UI's like using secenkit or special animations )

describe about the API end points that using and what types of data that retrieving and sending.

this can be document by a diagram or explaining the data models that you create through out the app.

explain the classes, methods, protocols and extensions that used in each functionality.