I will write documentation for unity game mechanics and systems in obsidian
Game developer with experience
About this Gig
I will document you game mechanic or a system in an Obsidian vault. You may provide an existing vault, or I can create one. I will first review your code so that I may understand what I'm writing, then I will start to map out the mechanic, then the scripts.
If you wish to format the documentation differently, I am open to that as well.
My usual documentation structure:
For the mechanic:
- About - What the mechanic or the system should do, its possible quirks
- Get started - A guide on how to get started, set up the system.
- Mechanics / Methods / Technicalities - this depends on the mechanic or system
- Nuances - if needed
- Dependencies - links to scripts connected to the specific script, system or mechanic
For the scripts:
- About - this includes the path to the script, its purpose and possible quirks.
- Get started - if needed for that particular script.
- Variables - this section will explain the role of each variable, private or public.
- Technicalities - This includes methods, their proper usage, nuances and more if needed.
Document type:
Documentation
Industry:
Software
Language:
English
•
Slovak
Delivery style preference
Please inform the freelancer of any preferences or concerns regarding the use of AI tools in the completion and/or delivery of your order.
FAQ
Can you work with other game engines?
I prefer Unity, as its the one I have most experience with. I may be able to take up on a new engine, but I won't promise anything.
What if I need to document a larger system?
We can negotiate on a deal.

