I will typically document things on a wiki page or a README beside the source code. But generally only if something is non-obvious. For example, it was not obvious to me how to setup a linux machine and join it to our domain and give domain admins sudo access. So after I had to do this, I wrote a wiki page for it.
Or certain high-level decisions may impose limitations. A document detailing the pros and cons and why the specific trade-off was chosen. My example here is using append-only log-based storage. This carries limitations in how the data structures can evolve and remain backward compatible, and procedures for making backward-incompatible changes.
For further actions, you may consider blocking this person and/or reporting abuse
We're a place where coders share, stay up-to-date and grow their careers.
I will typically document things on a wiki page or a README beside the source code. But generally only if something is non-obvious. For example, it was not obvious to me how to setup a linux machine and join it to our domain and give domain admins sudo access. So after I had to do this, I wrote a wiki page for it.
Or certain high-level decisions may impose limitations. A document detailing the pros and cons and why the specific trade-off was chosen. My example here is using append-only log-based storage. This carries limitations in how the data structures can evolve and remain backward compatible, and procedures for making backward-incompatible changes.