Follow

Long, on documentation (kinda) 

When I'm procrastinating from getting actual work done, I document things. Random things.

There's a README file in almost every directory in my computer, each of which talks about the files and structure of the directory. My home folder has an introduction to the system, where things are in general, which programs are installed, and how to find docs for them.

I have a Vim cheatsheet taped to the side of one of my computers, so I can glance at it without having to switch my workspace.

It's a very good way to waste time. Sometimes I come across an ancient project that doesn't compile and I'm like "What the heck is this, and why doesn't it compile?"
And there's a code comment that just says "*this* is what this is, and *this* is why it doesn't compile!" and well yeah it's just handy.

Long, on documentation (kinda) 

@MutoShack
That's a very good idea! Something that goes to the 'top' like 000Readme.txt or something.
I have tried many things over the years to create useful taxonomies for my hd's and including for notes.
Amiga used to have a place for a comment on every file ala ctime, mtime, size, w/e. There is an onerous way to do this in *nix, but not worth it.
Lots of attempts. You need a script to create nested dirs of the library of congress for e.g.? Just hit me up ;-)

Long, on documentation (kinda) 

@MutoShack I had the russian alphabet taped to my wall until just recently. I have meta+(initial) to change keyboards e.g. meta+r for russian and ctrl-meta+r to throw a keyboard map up on my left monitor. I have entire desktops that exist mostly just because their wallpaper is e.g. a map of the world or a postscript output of a 'remind' calendar... I once duplicated my dir structure in zimwiki. These days I'm thinking of going the other way 'round from joplin...

re: Long, on documentation (kinda) 

@MutoShack This is all valid, but working on a project for somebody else, you're forced^Wencouraged to progress as fast as possible, skipping the documentation and refactoring, and always implementing more and more new features, until it becomes incomprehensible mess; only then you're allowed to spend some time on "garbage collection", just enough to move a little bit farther.

re: Long, on documentation (kinda) 

@amiloradovsky

It's true. Code comments are great but often times, in a professional environment, they get lost/outdated pretty fast.

Sign in to participate in the conversation
Functional Café

The social network of the future: No ads, no corporate surveillance, ethical design, and decentralization! Own your data with Mastodon!