I read a README file I wrote a few weeks ago and decided it didn't have enough information, so it's now twice as long with a lot more detail.
-
I read a README file I wrote a few weeks ago and decided it didn't have enough information, so it's now twice as long with a lot more detail.
I'm the only one who will ever read or use the file, but I have learned I cannot rely on my own memory a few months or years from now when I need to revisit the project or do something similar.
Make notes! Make more notes. It's a text file, it won't take up much space but it might save you a bunch of time in the future.
@rasterweb Yes! I'll write documentation with a voice that assumes someone else will eventually read it, but is primarily for my own benefit.
Also, label makers: my house (and especially the old camper van I've been fixing up for the last 6 months or so) is filled with labels with the theme being "I don't use this often enough to remember this fact but want it to be quickly accessible when I do actually need it".
-
I read a README file I wrote a few weeks ago and decided it didn't have enough information, so it's now twice as long with a lot more detail.
I'm the only one who will ever read or use the file, but I have learned I cannot rely on my own memory a few months or years from now when I need to revisit the project or do something similar.
Make notes! Make more notes. It's a text file, it won't take up much space but it might save you a bunch of time in the future.
@rasterweb Senior Engineers write a lot of documentation, because they once found their three-line readme from when they were a Junior Engineer and the lack of information fucked them over in an epic way.
-
I read a README file I wrote a few weeks ago and decided it didn't have enough information, so it's now twice as long with a lot more detail.
I'm the only one who will ever read or use the file, but I have learned I cannot rely on my own memory a few months or years from now when I need to revisit the project or do something similar.
Make notes! Make more notes. It's a text file, it won't take up much space but it might save you a bunch of time in the future.
@rasterweb
This, 100%. I have a terrible memory so always make the effort to write good documentation, even if it's just for me. I also create aliases to run/stop/debug the project. -
I read a README file I wrote a few weeks ago and decided it didn't have enough information, so it's now twice as long with a lot more detail.
I'm the only one who will ever read or use the file, but I have learned I cannot rely on my own memory a few months or years from now when I need to revisit the project or do something similar.
Make notes! Make more notes. It's a text file, it won't take up much space but it might save you a bunch of time in the future.
@rasterweb Yes.
My reaction to my past notes is usually: I did that? -
@rasterweb Yes.
My reaction to my past notes is usually: I did that?@po3mah @rasterweb same here. I put readme file everywhere where i do so config etc. Usually I need that after a year or two, when sth breaks and in that i‘ve already forgot about that specail setting somewhere that made it work.
-
I read a README file I wrote a few weeks ago and decided it didn't have enough information, so it's now twice as long with a lot more detail.
I'm the only one who will ever read or use the file, but I have learned I cannot rely on my own memory a few months or years from now when I need to revisit the project or do something similar.
Make notes! Make more notes. It's a text file, it won't take up much space but it might save you a bunch of time in the future.
@rasterweb So true. I started entering notes into a note taker app many years ago for every single thing I worked on at the house or with some digital systems. It has been a real life saver when coming back to it later.
-
I read a README file I wrote a few weeks ago and decided it didn't have enough information, so it's now twice as long with a lot more detail.
I'm the only one who will ever read or use the file, but I have learned I cannot rely on my own memory a few months or years from now when I need to revisit the project or do something similar.
Make notes! Make more notes. It's a text file, it won't take up much space but it might save you a bunch of time in the future.
Preach it, brother.
Treat documentation like a WORM medium— Write Once, Read Many.
Write documentation like you wish it was written if you have to follow it at 3 in the morning after a party, when your pager went off and each hour is costing millions.
This is also a rant about improper LLM usage.
-
I read a README file I wrote a few weeks ago and decided it didn't have enough information, so it's now twice as long with a lot more detail.
I'm the only one who will ever read or use the file, but I have learned I cannot rely on my own memory a few months or years from now when I need to revisit the project or do something similar.
Make notes! Make more notes. It's a text file, it won't take up much space but it might save you a bunch of time in the future.
@rasterweb Indeed. I‘m leaving README files in various folders on our server to describe their contents for others and for myself.
-
I read a README file I wrote a few weeks ago and decided it didn't have enough information, so it's now twice as long with a lot more detail.
I'm the only one who will ever read or use the file, but I have learned I cannot rely on my own memory a few months or years from now when I need to revisit the project or do something similar.
Make notes! Make more notes. It's a text file, it won't take up much space but it might save you a bunch of time in the future.
@rasterweb This works so well! I remember a friend mentioned if he needed to stop work in the middle of something he wrote down the last thing he did so he could get back into it right away. I also have notes for projects where I have to take months long breaks. It's very effective.
-
I read a README file I wrote a few weeks ago and decided it didn't have enough information, so it's now twice as long with a lot more detail.
I'm the only one who will ever read or use the file, but I have learned I cannot rely on my own memory a few months or years from now when I need to revisit the project or do something similar.
Make notes! Make more notes. It's a text file, it won't take up much space but it might save you a bunch of time in the future.
@rasterweb Years ago, I decided to write a program I had always wanted while sitting in a bar drinking beer.
And I did, and it works!
And I have the hardest time modifying it, because some of the code is pure chaos, and I put in ZERO inline comments.
I am normally so good about inline comments. I strive to always include README and EXAMPLES files. But not that day.
I still use the program to this day, but hooboy.... adding features has been an adventure
-
R relay@relay.infosec.exchange shared this topic
