Like soup-to-nuts. I know I need to document what I'm doing and I've started several times, but then I never go back and make updates. I don't know if it's just the ADHD or if I'm just going about it or thinking about it in the wrong way.

So I'm curious about:

  • what you use for your documentation
  • how you organize it
  • what information you include
  • how you work documentation into your changes/tinkering flow

Edit: Dang, folks! You all have given me a lot to read through, think about, and explore. Thank you!

you are viewing a single comment's thread
view the rest of the comments
[–] 31 points 7 months ago (1 child)
  • what you use for your documentation

Markdown files

  • how you organize it

What ?

  • what information you include

The commands that worked and the stuff that didn't work and the links to the source of information

  • how you work documentation into your changes

I write as I go. I keep it as part of a git repository when relevant

  • source
  • hideshow 1 child comment
  • [–] 2 points 7 months ago

    Had to scroll down this far just to get to markdown files. Although I write with a bit of a delay. Once I get something working. Then I document what worked and what didn't. Alternative methods and issues I had with the alternatives.

  • source
  • parent