WelcomeUser Guide
ToSPrivacyCanary
DonateBugsLicense

©2024 Poal.co

545

TLDR; Write good documentation. Its not just for work, its also for life and will make your life easier/better.

Good documentation is extremely important. Think of it as your extended memory, with limited exceptions you are not going to remember that thing you did 4(or 8) years ago that one time because you had a strange edge case (regardless of the context. Tech, cars, gardening, etc).

The better the documentation the more repeatable it is. With technology you can pair that documentation as code or pictures or videos easily now too. It makes everything more logical and easier to follow but I suggest doing this in your own life.

Here is a example. Did you have to replace some plumbing for your sink or something like that? - Record what the problem is/was (leak, break, etc). - Take before pictures - Take during pictures - Take recordings of the parts you had to buy to replace the existing parts. - Record the cost of the parts and barcodes/part numbers for each item replaced. - Record the amount of time it took to do.. You can add more but that is the general idea.

You can ask for this from a tradesman too if you have them do work for you. Just ask for a itemized list and explain it is so if you ever have to replace something you know what part you might need. Every single one of these people I have asked are shocked I am asking but more than happy to share the information and even point out which part is where and is happy to share that with me. Show them respect and they will show you respect.

All of these things are useful. Sure, it adds a little time to what you are doing but now you have a record of it and can easily reference it. A situation like this could be used for a claim on insurance or your taxes for home repairs or tax breaks. What if it was a leak that cause damage but you fixed the leak but more damage needs to be repaired and you have to involve insurance?

I have written a lot of documentation posted online and since a bunch of you do tech stuff some of you probably have read at least one of them at one point but I don't have such a ego to dox myself. If it helped a single person that is all that matters.

Archive: https://archive.today/th354

From the post:

>Ikea is known as a purveyor of build-it-yourself flatpack furniture. Lego is known as a purveyor of build-it-yourself toys. Both are known for their instructions. The latter’s are considered incredibly clear and useful, while the former’s are often derided as arcane and confusing—though the major difference between the two is color printing. These two companies are great examples of why instructions are important. Indeed, Sonya Vasquez has learned this lesson well, and came down to Supercon 2023 to tell us all about it. Prepare to learn all about how to write great step-by-step instructions that enable greatness and never frustrate the end user.

TLDR; Write good documentation. Its not just for work, its also for life and will make your life easier/better. Good documentation is extremely important. Think of it as your extended memory, with limited exceptions you are not going to remember that thing you did 4(or 8) years ago that one time because you had a strange edge case (regardless of the context. Tech, cars, gardening, etc). The better the documentation the more repeatable it is. With technology you can pair that documentation as code or pictures or videos easily now too. It makes everything more logical and easier to follow but I suggest doing this in your own life. Here is a example. Did you have to replace some plumbing for your sink or something like that? - Record what the problem is/was (leak, break, etc). - Take before pictures - Take during pictures - Take recordings of the parts you had to buy to replace the existing parts. - Record the cost of the parts and barcodes/part numbers for each item replaced. - Record the amount of time it took to do.. You can add more but that is the general idea. You can ask for this from a tradesman too if you have them do work for you. Just ask for a itemized list and explain it is so if you ever have to replace something you know what part you might need. Every single one of these people I have asked are shocked I am asking but more than happy to share the information and even point out which part is where and is happy to share that with me. Show them respect and they will show you respect. All of these things are useful. Sure, it adds a little time to what you are doing but now you have a record of it and can easily reference it. A situation like this could be used for a claim on insurance or your taxes for home repairs or tax breaks. What if it was a leak that cause damage but you fixed the leak but more damage needs to be repaired and you have to involve insurance? I have written a lot of documentation posted online and since a bunch of you do tech stuff some of you probably have read at least one of them at one point but I don't have such a ego to dox myself. If it helped a single person that is all that matters. Archive: https://archive.today/th354 From the post: >>Ikea is known as a purveyor of build-it-yourself flatpack furniture. Lego is known as a purveyor of build-it-yourself toys. Both are known for their instructions. The latter’s are considered incredibly clear and useful, while the former’s are often derided as arcane and confusing—though the major difference between the two is color printing. These two companies are great examples of why instructions are important. Indeed, Sonya Vasquez has learned this lesson well, and came down to Supercon 2023 to tell us all about it. Prepare to learn all about how to write great step-by-step instructions that enable greatness and never frustrate the end user.

Be the first to comment!