Tips for Writing Documentation

Before You Start

Use a Template
Templates are a great way of organizing your work.
They save you time while thinking, writing, revising & reworking.
They provide guidance to your writing & thinking.

Save Dates of Important Events
The Date of Creation, Major Changes, Reworks, Releases and other Important Events can be very helpful to track history later on and to understand the Projects Development for others.

Version your Documents
Versioning helps you further in tracking development & can give an approximate estimate on the projects statistics (amount of work gone in, project age, project stage).

Share Note for Obsidian 🌓