What is Documentation and Why Use It?⌗

Documentation is like a helpful note about your work. It helps both you and others understand the software you made. Think of it like a user manual for your code.

What’s in Good Documentation?⌗

Good documentation clearly tells:

• How to start the software.
• How to set it up.
• What the software does.
• How tests work.
• Extra info about things like APIs.

It also talks about the software’s features and what’s needed to make it run.

A Simple Checklist for Documentation⌗

Here’s a basic list to help you start writing documentation:

Checklist⌗

• What’s This? – A short description.
• Project Status – Is it active or no longer updated?
• Badges – Icons showing build status, contributors, etc.
• Purpose – What’s the main goal of the software?
• Who Made This? – Your name or your team’s name.
• Needs – Things required to run the software (with links).
• Features – List of main features or functions.
• Starting Steps – How to get the software running.
• Technical Choices – Reasons for using certain tools or databases.
• Testing Steps – How to test the software.
• License – Information about usage rights.
• How to Contribute – Steps for people who want to help or make changes.
• Future Plans – List of upcoming features or updates.

Other Things to Note Down⌗

Explain business objects and rules. Keep them in a simple format. Using tools like GIT can help track changes.

What’s UML?⌗

UML helps make charts for software systems. It shows how a system is built and how it works.

Tools to Help You⌗

PlantUML⌗

To know more about how PlantUML can help, click HERE.

Mermaid⌗

You can use Mermaid to make charts right in your notes. To learn more, click HERE.