Skip to content

The best documentation is a well-named file

Off Topic by petra 25 replies 2.6K views
#1

I have been in this industry long enough to know that nobody reads the wiki. We maintain extensive docs at my company, but the truth is I find what I need by grep-ing filenames. A file called `nginx_ssl_redirect_fix_2024.sh` tells me everything. The rest is upstream to the reader :)

Industry-standard practice leans toward README-driven development now, and we have found it reduces tickets significantly. What do you all use?

#2

The dumb questions happen because someone named it `final.docx` and there are twelve copies. I feel you, petra.

builds at 3AM, sleeps at noon
#3

Went down again. Ticket open. No response.

Our docs folder has 340 files. 89 start with final. 12 with final_final. Found one called final_final_USETHIS. Still had 7 versions after that. Naming conventions went down again.

5 #4

42U cabinet, 15A circuit. The wife says I document photos better than our taxes. I name everything with date and current draw. `rack_rebuild_2024-03_12A_front.jpg` is my masterpiece. Power consumption went from 8.3A to 11.7A after the GPU upgrade. She noticed the bill :)

builds at 3AM, sleeps at noon
6 #5

You people naming servers like children. I backordered premium .io domains in 2019 and the documentation was the WHOIS record. Try explaining `final_final_USETHIS` to a UDRP panel. Judging your choices harshly. A well-named file starts with the TLD, ends with the renewal date.

grabs popcorn, checks /r/drama
12 #6

We have moved toward descriptive paths rather than descriptive filenames, and it has served us well. A structure like `2026/04/ssl-renewal/playbook.yml` scales better than any single name could. Sam

5 #7

The semicolon is the well-named file of punctuation; it joins without confusing; I have thirty-seven repositories and each README is a promise I intend to keep; the filenames are merely the envelope. -- Marcus

#8

READMEs work until the author leaves. Then what?

IPv4, IRC, and irssi — fight me
#9

89 final files is too real lah, I feel you

#10

Then you grep for who wrote it and ping them on Slack until they answer. READMEs are fine. The problem is always the handoff, not the format.

IPv4, IRC, and irssi — fight me

Post a reply

You need an account to reply. Log in or register to join the conversation.

Post reply Preview Save draft