Skip to main content

Documentation

Documentation is crucial for both short and long projects. It is important to scatter documentation throughout the code and have additional documentation in separate documents for ease of reference.

In long-running projects that span multiple years, the ability to maintain the code is essential. Different developers may work on the same pieces of code over time, making documentation a valuable tool for saving time and avoiding confusion.

Even in shorter projects, documentation plays a vital role. A getting started guide can be indispensable for new developers and helps the project to be flexible as requirements or deadlines change. With multiple people working on the project at once, documentation becomes critical for collaboration and helps to avoid unnecessary back-and-forth communication, especially with team members in different time zones.

It is important to note that short projects may eventually become long-term projects, and having proper documentation in place makes it easier to pick up where you left off. This ensures a smooth transition and helps to save time in the long run.